get
https://{subdomain}.recurly.com/v2/subscriptions/
Subscription Attributes
| Subscription Parameters | Description |
|---|---|
| plan | Nested plan_code and plan name |
| uuid | Unique subscription ID |
| active | "active", "canceled", "future", "expired" |
| unit_amount_in_cents | Unit amount of the subscription |
| quantity | Unit amount of the subscription |
| currency | 3-letter ISO currency for the subscription |
| activated_at | Date the subscription started |
| canceled_at | Date the subscription was marked canceled |
| expires_at | Date the subscription will end (if state is "canceled") or ended (if state is "expired") |
| current_period_started_at | Date the current bill cycle started |
| current_period_ends_at | Date the current bill cycle will end |
| trial_started_at | Date the trial was started, if applicable |
| trial_ends_at | Date the trial ended, if applicable |
| tax_in_cents | Amount of tax or VAT within the transaction, in cents. |
| tax_type | Tax type as "vat" for VAT or "usst" for US Sales Tax. |
| tax_region | Region where taxes are applied. |
| tax_rate | Tax rate that will be applied to this subscription. |
| po_number | PO number reference. |
| net_terms | Invoice net terms in days. |
| collection_method | Invoice collection as "automatic" or "manual". |
| subscription_add_ons | Nested list of add-ons on the subscription, if applicable |
| pending_subscription | Nested information about a pending subscription change at renewal |
| terms_and_conditions | Optional notes field. This will default to the Terms and Conditions text specified on the Invoice Settings page in your Recurly admin. Specify custom notes with this tag to add or override Terms and Conditions. Custom notes will stay with a subscription on all renewals. |
| customer_notes | Optional notes field. This will default to the Customer Notes text specified on the Invoice Settings page in your Recurly admin. Specify custom notes with this tag to add or override Customer Notes. Custom notes will stay with a subscription on all renewals. |
| bank_account_authorized_at | Recurring subscriptions paid with ACH will have this attribute with an iso8601 timestamp value. This timestamp is used for alerting customers to reauthorize in 3 years in accordance with NACHA rules. If a subscription becomes inactive or the billing info is no longer a bank account, this timestamp is cleared and the attribute will not exist. |
PENDING SUBSCRIPTION CHANGES
When looking up a subscription that has pending changes, the new subscription details will be in a pending_subscription node. Since immediate subscription changes take place immediately, pending subscription changes will only show for changes occurring when the subscription renews.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…