Subscriptions

Available queries

Associated query	Returns multiple results
Subscription
Subscriptions	✔️

Available fields

Label	Type	Notes	Null
account_manager	Account manager	The account manager associated to this document	✔️
billing_cycle	integer	The time gap between each billing (in months)
bill_to	Address	The billing address	✔️
changed	Date	The date of the subscription's last modification
created	Date	The date of the subscription's creation
cycle_limit	string	How many month until the subscription expires (in months)	✔️
currency	Currency	The currency used in this document	✔️
customer	Customer	The customer this document is addressed to	✔️
discount	decimal(10,2)	The discount applied in this document	✔️
exchange_rate	decimal(12,6)	The exchange rate for this document's currency	✔️
external_reference	string	The external reference of this document	✔️
end_date	string	Indicates if this subscription should expire ("never" or "after")	✔️
first_billing_date	string	The date of the first billing	✔️
for_the_attention_of	string	The person this document is addressed to	✔️
global_discount	decimal(12,2)	The global discount applied to the document	✔️
id	integer	The id of the document
internal_notes	string	Notes about this document that only you will see	✔️
invoices_created	Invoices	The invoices created from this document	✔️
label	string	The order number of this specific subscription. Automatically generated
line_items	Line items	The line items of the document
location	Location	The location used in the document	✔️
notes	string	Notes about this document that you AND the customer will see	✔️
price_level	Price level	The price level used in this document
renewal_date	DateNoHour	When the subscription should be renewed	✔️
specific_day	string		✔️
subscription_status	string	The status of this document ("active", "cancelled")
subtotal	decimal(12,2)	The subtotal of this document
taxes	Taxes	The taxes used in this document	✔️
tax_type	Object	The type of taxes in this document	✔️
terms_and_conditions	string	The terms and condition of this document	✔️
total	decimal(12,2)	The total of this document
total_taxes	Total taxes	The total taxes of this document	✔️
total_units	decimal7)	The total units of this order
user	User	The user who created this order

Example of a query

JSON

query{
  Subscriptions{
    edges{
      node{
        account_manager{
          id
        }
        billing_cycle
        bill_to{
          country
        }
        changed
        created
        cycle_limit
        currency{
          id
        }
        customer{
          id
        }
        discount
        exchange_rate
        external_reference
        end_date
        first_billing_date
        for_the_attention_of
        global_discount
        id
        internal_notes
        invoices_created{
          edges{
            node{
              id
            }
          }
        }
        label
        line_items{
          edges{
            node{
              id
            }
          }
        }
        location{
          id
        }
        notes
        price_level{
          id
        }
        renewal_date
        specific_day
        subscription_status
        subtotal
        taxes{
          edges{
            node{
              id
            }
          }
        }
        terms_and_conditions
        total_taxes{
          edges{
            node{
              id
            }
          }
        }
        total_units
        user{
          display_name
        }
      }
    }
  }
}