Retrieves the subscription with the given subscription key (number or ID).
Allows you to specify which fields are returned in the response.
Accepted values
`custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `subscription_number`, `state`, `account_id`, `invoice_owner_account_id`, `auto_renew`, `version`, `initial_term`, `current_term`, `renewal_term`, `start_date`, `end_date`, `description`, `contract_effective`, `service_activation`, `customer_acceptance`, `invoice_separately`, `latest_version`, `payment_terms`, `billing_document_settings`, `bill_to_id`, `sold_to_id`, `contracted_mrr`, `currency`, `cancel_reason`, `last_booking_date`, `order_number`Allows you to specify which fields are returned in the response.
Accepted values
`custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `subscription_number`, `state`, `account_id`, `invoice_owner_account_id`, `auto_renew`, `version`, `initial_term`, `current_term`, `renewal_term`, `start_date`, `end_date`, `description`, `contract_effective`, `service_activation`, `customer_acceptance`, `invoice_separately`, `latest_version`, `payment_terms`, `billing_document_settings`, `bill_to_id`, `sold_to_id`, `contracted_mrr`, `currency`, `cancel_reason`, `last_booking_date`, `order_number`Allows you to specify which fields are returned in the response.
Accepted values
`custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `name`, `plan_id`, `subscription_id`, `product_id`, `subscription_plan_number`Allows you to specify which fields are returned in the response.
Accepted values
`custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `start_date`, `end_date`, `charge_model`, `charge_type`, `tiers`, `subscription_item_number`, `name`, `description`, `charged_through_date`, `recurring`, `price_id`, `start_event`, `tax_code`, `tax_inclusive`, `unit_of_measure`, `quantity`, `price_base_interval`, `overage`, `subscription_plan_id`, `tiers_mode`, `processed_through_date`, `active`, `state`, `unit_amount`, `amount`, `discount_amount`, `discount_percent`, `price_change_percentage`, `price_change_option`Allows you to specify which fields are returned in the response.
Accepted values
`custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `auto_pay`, `account_number`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `communication_profile_id`, `crm_id`, `sales_rep`, `parent_account_id`, `payment_gateway`, `payment_terms`, `remaining_credit_memo_balance`, `remaining_debit_memo_balance`, `remaining_invoice_balance`, `remaining_payment_balance`, `sequence_set_id`, `tax_certificate`, `batch`, `tax_identifier`, `bill_cycle_day`, `description`, `name`, `currency`, `default_payment_method_id`, `enabled`Allows you to specify which fields are returned in the response.
Accepted values
`custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `auto_pay`, `account_number`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `communication_profile_id`, `crm_id`, `sales_rep`, `parent_account_id`, `payment_gateway`, `payment_terms`, `remaining_credit_memo_balance`, `remaining_debit_memo_balance`, `remaining_invoice_balance`, `remaining_payment_balance`, `sequence_set_id`, `tax_certificate`, `batch`, `tax_identifier`, `bill_cycle_day`, `description`, `name`, `currency`, `default_payment_method_id`, `enabled`Allows you to specify which fields are returned in the response.
Accepted values
`custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `start_date`, `end_date`, `name`, `active`, `description`, `plan_number`, `product_id`, `active_currencies`Allows you to specify which fields are returned in the response.
Accepted values
`custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `start_date`, `end_date`, `active`, `name`, `type`, `sku`, `description`Allows you to specify which fields are returned in the response.
Accepted values
`custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `tiers`, `charge_model`, `charge_type`, `name`, `description`, `revenue_recognition_rule`, `stacked_discount`, `recognized_revenue_accounting_code`, `deferred_revenue_accounting_code`, `accounting_code`, `recurring`, `start_event`, `tax_code`, `tax_inclusive`, `taxable`, `unit_of_measure`, `quantity`, `min_quantity`, `max_quantity`, `price_base_interval`, `discount_level`, `overage`, `plan_id`, `tiers_mode`, `apply_discount_to`, `prepayment`, `drawdown`, `discount_amounts`, `unit_amounts`, `discount_percent`, `amounts`, `price_change_percentage`, `price_change_option`, `price_increase_option`Allows you to specify which fields are returned in the response.
Accepted values
`custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax`Allows you to expand responses by including related object information in a single call. See the Expand responses section of the Quickstart API Tutorials for detailed instructions.
A case-sensitive filter on the list. See the Filter lists section of the Quickstart API Tutorial for detailed instructions.
Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the "Retrieve a billing document" operation, you can use the filter[] parameter on the related objects such as filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63
A custom identifier for tracking API requests. If you set a value for this header, Zuora returns the same value in the response header. This header enables you to track your API calls to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), or quote (').
Making asynchronous requests allows you to scale your applications more efficiently by leveraging Zuora's infrastructure to enqueue and execute requests for you without blocking. These requests also use built-in retry semantics, which makes them much less likely to fail for non-deterministic reasons, even in extreme high-throughput scenarios. Meanwhile, when you send a request to one of these endpoints, you can expect to receive a response in less than 150 milliseconds and these calls are unlikely to trigger rate limit errors. If set to true, Zuora returns a 202 Accepted response, and the response body contains only a request ID.
An entity ID. If you have Multi-entity enabled and the authorization token is valid for more than one entity, you must use this header to specify which entity to perform the operation on. If the authorization token is only valid for a single entity or you do not have Multi-entity enabled, you do not need to set this header.
Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. This idempotency key should be a unique value, and the Zuora server identifies subsequent retries of the same request using this value. For more information, see Idempotent Requests.
Include a accept-encoding: gzip header to compress responses, which can reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes. For more information about this header, see Request and Response Compression.
Include a content-encoding: gzip header to compress a request. Upload a gzipped file for the payload if you specify this header. For more information, see Request and Response Compression.
Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.
The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails.
If the header is not set, the operation is performed in scope of the user's accessible orgs.
- https://rest.test.zuora.com/v2https://rest.test.zuora.com/v2/subscriptions/{subscription_id}
- US API Sandbox Cloud 1https://rest.sandbox.na.zuora.com/v2/subscriptions/{subscription_id}
- US API Sandbox Cloud 2https://rest.apisandbox.zuora.com/v2/subscriptions/{subscription_id}
- US Production Cloud 1https://rest.na.zuora.com/v2/subscriptions/{subscription_id}
- US Production Cloud 2https://rest.zuora.com/v2/subscriptions/{subscription_id}
- https://rest.test.eu.zuora.com/v2https://rest.test.eu.zuora.com/v2/subscriptions/{subscription_id}
- EU API Sandboxhttps://rest.sandbox.eu.zuora.com/v2/subscriptions/{subscription_id}
- EU Productionhttps://rest.eu.zuora.com/v2/subscriptions/{subscription_id}
- https://rest.test.ap.zuora.com/v2https://rest.test.ap.zuora.com/v2/subscriptions/{subscription_id}
- APAC Productionhttps://rest.ap.zuora.com/v2/subscriptions/{subscription_id}
curl -i -X GET \
'https://rest.test.zuora.com/v2/subscriptions/{subscription_id}?fields%5B%5D=id%2Ccreated_time&subscription.fields%5B%5D=id%2Ccreated_time&subscription_plans.fields%5B%5D=id%2Ccreated_time&subscription_items.fields%5B%5D=id%2Ccreated_time&account.fields%5B%5D=id%2Ccreated_time&invoice_owner_account.fields%5B%5D=id%2Ccreated_time&plan.fields%5B%5D=id%2Ccreated_time&product.fields%5B%5D=id%2Ccreated_time&price.fields%5B%5D=id%2Ccreated_time&bill_to.fields%5B%5D=id%2Ccreated_time&prepaid_balance.fields%5B%5D=id%2Ccreated_time&prepaid_balances.fields%5B%5D=id%2Ccreated_time&validity_period.fields%5B%5D=id%2Ccreated_time&transactions.fields%5B%5D=id%2Ccreated_time&expand%5B%5D=string&filter%5B%5D=string&page_size=1' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'accept-encoding: string' \
-H 'async: false' \
-H 'content-encoding: string' \
-H 'idempotency-key: string' \
-H 'zuora-entity-ids: string' \
-H 'zuora-org-ids: string' \
-H 'zuora-track-id: string'Default Response
The request limit quota for the time window closest to exhaustion. See rate limits for more information.
The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.
The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.
The date and time when the object was last updated in ISO 8601 UTC format.
The date and time when the object was created in ISO 8601 UTC format.
Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format.
Status of the subscription.
The version of the subscription. This version can be used in the filter[] query parameter to filter subscriptions.
Identifier of the account that owns the invoice associated with this subscription.
If this field is set to true, the subscription automatically renews at the end of the current term.
Date when the subscribed-to service is activated.
Date when all the services or products in the subscription are accepted by the subscriber.
If true, the subscription is billed separately from other subscriptions. If false, the subscription is included with other subscriptions in the account invoice. The default is false.
Total prepaid units available during a subscription. It is an aggregate of all funds under a subscription.
3-letter ISO 4217 currency code. This field is available only if you have the Multiple Currencies feature enabled.
The last booking date of the subscription object. You can override the date value when creating a subscription through the "Subscribe and Amend" API. The default value today is set per the user's timezone. The value of this field is as follows:
- For a new subscription created by the Subscribe and Amend APIs, this field has the value of the subscription creation date.
- For a subscription changed by an amendment, this field has the value of the amendment booking date.
- For a subscription created or changed by an order, this field has the value of the order date.
The billing document settings for the customer.
{ "id": "8ad08ccf8437067601843a7af4e64rq3", "custom_fields": { "field__c": "custom field value" }, "subscription_number": "A-S0001332401234", "state": "active", "account_id": "2c92c0f86a8dd422016a9e7a70116b0d", "invoice_owner_account_id": "2c92c0f86a8dd422016a9e7a70116b0d", "auto_renew": true, "latest_version": true, "initial_term": { "interval_count": 1, "interval": "month", "type": "termed" }, "current_term": { "interval_count": 1, "interval": "month", "start_date": "2022-07-01", "type": "termed", "end_date": "2022-08-01" }, "start_date": "2022-07-01", "end_date": "2022-08-01", "description": "Create Subscription", "contract_effective": "2022-07-01", "service_activation": "2022-07-01", "customer_acceptance": "2022-07-01", "invoice_separately": false, "order_number": "O-00020812" }