Skip to main content

Querying for subscriptions

GET 
/api/v3/package

Available query parameter values for filtering:

  • package_id
  • customer_id
  • token
  • brand_id
  • custom_N - Example: custom_1, custom_2, etc.
  • paymethod
  • paycycle
  • nickname
  • bill_state
  • ship_state
  • package_status_str
  • package_status_state
  • external_key
  • write_datetime - date/time created
  • mod_datetime - date/time last modified
  • cancel_datetime
  • quote.quote_id - Get the subscription that originated from a specific quote
  • line_items.external_key
  • line_items.custom_1
  • line_items.item_id - Get subscriptions that contain a specific product/discount
  • customer.superuser_email - Get subscriptions for a specific primary contact email address
  • customer.users.email - Get subscriptions with this email address

Valid values for package_status_state:

  • a (for active packages)
  • c (for cancelled packages)
  • e (for expired packages)
  • s (for suspended packages)

Valid values for package_status_str:

  • active-trial
  • active-current
  • active-overdue
  • canceled-nonpayment
  • canceled-manual
  • expired-expired
  • expired-trial
  • suspended-suspended

Request​

Query Parameters

    where string

    package_status_state:EQUALS:a

    order string

    package_id:ASC

    limit string

    2

    offset string

    8

Responses​

Object was fetched successfully

Schema

    code integer
    status string
    message stringnullable
    details objectnullable

    response

    object[]

  • Array [

    • package_id integer

    Subscription ID #

    customer_id integer

    Customer ID #

    brand_id integer

    Brand ID #

    brand_name string

    Brand name

    class_id integer

    Class ID #

    class_name string

    Class name

    external_key string

    External key value

    token string

    Unique token

    nickname string

    Nickname for the subscription

    paymethod string

    Payment method for the subscription, one of: crd, inv, ach, tok

    paymethod_name string

    Payment method for the subscription (e.g. Credit Card)

    paymethod_detail string

    Payment method details (e.g. "Visa x1111")

    creditcard_id integer

    Credit card ID # (if the subscription is paid by credit card)

    ach_id integer

    ACH ID # (if the subscription is paid by ACH)

    tokenized_id integer

    Tokenized ID # (if the subscription is paid by an external service token)

    admin_id integer

    Admin/worker ID #

    admin_name string

    Admin/worker name

    bill_addr1 string

    Billing address line 1

    bill_addr2 string

    Billing address line 2

    bill_addr3 string

    (Deprecated)

    bill_city string

    Billing address city

    bill_state string

    Billing address state

    bill_postcode string

    Billing address postal code

    bill_country string

    Billing address country

    bill_notes string

    (Deprecated)

    ship_addr1 string

    Shipping address line 1

    ship_addr2 string

    Shipping address line 2

    ship_addr3 string

    (Deprecated)

    ship_city string

    Shipping address city

    ship_state string

    Shipping address state

    ship_postcode string

    Shipping address postal code

    ship_country string

    Shipping address country

    ship_notes string

    (Deprecated)

    memo string

    Memo/notes to customer

    currency_id integer

    Currency ID #

    currency_iso4217 string

    Currency ISO 4217 code

    currency_symbol string

    Currency symbol

    amount_collected float

    Total amount collected so far for this subscription

    amount_invoiced float

    Total amount invoiced so far

    amount_due float

    Total amount due (invoiced - collected)

    amount_overdue float

    Total amount past due

    suspendfrom_datetime string

    Date/time this subscription was suspended from

    suspendto_datetime string

    Date/time this subscription was suspended to

    next_invoice_datetime string

    The date the next invoice will be generated

    is_overdue boolean

    Whether or not the subscription is overdue

    days_overdue integer

    Number of days overdue the subscription is

    start_datetime string

    Date/time this subscription was started/effective

    cancel_datetime string

    Date/time this subscription was cancelled

    write_datetime string

    Date/time this subscription was created

    mod_datetime string

    Date/time this subscription was last updated, upgraded, downgraded, etc.)

    holduntil_datetime string

    Date/time invoicing for this subscription is being delayed until

    package_status_id integer

    Subscription status ID #

    package_status_name string

    Human-friendly subscription status

    package_status_str string

    Status string

    package_status_state string

    Status code

    mrr float

    Current monthly recurring revenue of the subscription

    arr float

    Current annual recurring revenue of the subscription

    cancel_reason string

    Reason for cancellation

    terms_id integer

    Terms ID #

    terms_name string

    Payment terms

    terms_days integer

    Terms number of days

    paycycle string

    Payment cycle

    paycycle_name string

    Payment cycle name

    custom_1 string

    Custom field #1

    custom_2 string

    Custom field #2

    custom_3 string

    Custom field #3

    custom_4 string

    Custom field #4

    custom_5 string

    Custom field #5

    custom_6 string

    Custom field #6

    custom_7 string

    Custom field #7

    custom_8 string

    Custom field #8

    custom_9 string

    Custom field #9

    custom_10 string

    Custom field #10

    custom_11 string

    Custom field #11

    custom_12 string

    Custom field #12

    custom_13 string

    Custom field #13

    custom_14 string

    Custom field #14

    custom_15 string

    Custom field #15

    custom_16 string

    Custom field #16

    custom_17 string

    Custom field #17

    custom_18 string

    Custom field #18

    custom_19 string

    Custom field #19

    custom_20 string

    Custom field #20

    first_invoice_schedule_template_id integer

    Payment schedule to use for the first invoice generated

    recurring_invoice_schedule_template_id integer

    Payment schedule to use for subsequent generated invoices

    line_items

    object[]

    A list of line items for the subscription

  • Array [

    • line_item_id integer

    Line item ID #

    package_id integer

    Package ID #

    external_key string

    External key value

    item_id integer

    Item ID #

    admin_id integer

    Admin worker ID # (sales rep)

    item_name string

    Item name

    item_external_key string

    Item external key

    item_accounting_sku string

    Item accounting SKU

    item_token string

    Item token

    item_units float
    item_type string

    Item type

    item_is_usage bool

    Whether or not the item is usage-based/metered

    line_item_bundle_id integer

    Item bundle ID #

    tierset_id integer
    nickname string

    Nickname for this line of the subscription

    descrip string

    Description

    trial_days integer

    (Deprecated - see trial_recurs)

    trial_units float
    trial_recurs integer

    Number of free trial cycles/cycles to skip

    expire_datetime string
    expire_recurs integer

    Number of invoices to occur on before expiring

    line_quantity float

    Quantity

    subscribe_datetime string

    The date/time this line item was last upgraded, downgraded, or added

    subscribe_prorate_from_datetime string
    subscribe_prorate_to_datetime string
    cancel_datetime string

    The date/time this line item was cancelled

    custom_1 string

    Custom field #1

    custom_2 string

    Custom field #2

    custom_3 string

    Custom field #3

    custom_4 string

    Custom field #4

    custom_5 string

    Custom field #5

    custom_6 string

    Custom field #6

    custom_7 string

    Custom field #7

    custom_8 string

    Custom field #8

    custom_9 string

    Custom field #9

    custom_10 string

    Custom field #10

    custom_11 string

    Custom field #11

    custom_12 string

    Custom field #12

    custom_13 string

    Custom field #13

    custom_14 string

    Custom field #14

    custom_15 string

    Custom field #15

    custom_16 string

    Custom field #16

    custom_17 string

    Custom field #17

    custom_18 string

    Custom field #18

    custom_19 string

    Custom field #19

    custom_20 string

    Custom field #20

    tierset array

    The pricing for the line item

  • ]

    • tags string[]

    A list of tags

    url_self string

    URL for viewing the subscription in the GUI

  • ]

Loading...