Uncancel a subscriptionDeprecated

Uncancel a cancelled subscription.

SecuritybearerAuth
Request
path Parameters
subscription_id
required
string

Identifier for the subscription, either subscription_number or subscription_id

query Parameters
fields[]
Array of strings

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

Example: fields[]=id,created_time
subscription_plans.fields[]
Array of strings

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

Example: subscription_plans.fields[]=id,created_time
subscription_items.fields[]
Array of strings

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

Example: subscription_items.fields[]=id,created_time
account.fields[]
Array of strings

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

Example: account.fields[]=id,created_time
invoice_owner_account.fields[]
Array of strings

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

Example: invoice_owner_account.fields[]=id,created_time
plan.fields[]
Array of strings

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

Example: plan.fields[]=id,created_time
product.fields[]
Array of strings

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

Example: product.fields[]=id,created_time
price.fields[]
Array of strings

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

Example: price.fields[]=id,created_time
bill_to.fields[]
Array of strings

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

Example: bill_to.fields[]=id,created_time
prepaid_balance.fields[]
Array of strings

Allows you to specify which fields are returned in the response.

Accepted values prepaid_UOM, start_date, end_date, total_balance, remaining_balance

Example: prepaid_balance.fields[]=id,created_time
prepaid_balances.fields[]
Array of strings

Allows you to specify which fields are returned in the response.

Accepted values validity_periods

Example: prepaid_balances.fields[]=id,created_time
validity_period.fields[]
Array of strings

Allows you to specify which fields are returned in the response.

Accepted values prepaid_UOM, start_date, end_date, total_balance, remaining_balance, overage_rated_amount, overage_rated_quantity

Example: validity_period.fields[]=id,created_time
transactions.fields[]
Array of strings

Allows you to specify which fields are returned in the response.

Accepted values transaction_date, type, quantity

Example: transactions.fields[]=id,created_time
expand[]
Array of strings

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.

filter[]
Array of strings

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

page_size
integer [ 1 .. 99 ]

The maximum number of results to return in a single page. If the specified page_size is less than 1 or greater than 99, Zuora will return a 400 error.

header Parameters
zuora-track-id
string

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 (').

async
boolean
Default: false

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.

zuora-entity-ids
string

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.

idempotency-key
string

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.

accept-encoding
string

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.

content-encoding
string

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.

Request Body schema: application/json
required
description
string

Description of the subscription.

object (CustomFields)

Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format.

object (SubscriptionTermPatchRequest)

Term information of the subscription.

object (StartOn)

Container for the contract effective, service activation, and customer acceptance dates of the order action or subscription.

  • If Zuora is configured to require service activation and the service_activation field is not set for a subscription_plans order action or the "Create a subscription" operation, a pending order and/or a pending_activation subscription are created.
  • If Zuora is configured to require customer acceptance and the customer_acceptance field is not set for a subscription_plans order action or the "Create a subscription" operation, a pending order and/or a pending_acceptance subscription are created. At the same time, if the service activation date field is also required and not set, a pending order and/or a pending_activation subscription are created instead.
  • If Zuora is configured to require service activation and the service_activation field is not set for any of the following order actions or the "Update a subscription" operation, a pending order is created. The subscription status is not impacted. Note: This feature is in Limited Availability. If you want to have access to the feature, submit a request at Zuora Global Support.
    • add_subscription_plans
    • update_subscription_plans
    • remove_subscription_plans
    • renew
    • terms
  • If Zuora is configured to require customer acceptance and the customer_acceptance field is not set for any of the following order actions or the "Update a subscription" operation, a pending order is created. The subscription status is not impacted. Note: This feature is in Limited Availability. If you want to have access to the feature, submit a request at Zuora Global Support.
    • add_subscription_plans
    • update_subscription_plans
    • remove_subscription_plans
    • renew
    • terms

invoice_owner_account_id
string

Identifier of the account that owns the invoice associated with this subscription.

invoice_owner_account_number
string

Identifier of the account that owns the invoice associated with this subscription.

account_id
string

Identifier of the account that owns the subscription. Subscription owner account can be different from the invoice owner account.

account_number
string

Identifier of the account that owns the subscription. Subscription owner account can be different from the invoice owner account.

Array of objects (SubscriptionAddPlanPatchRequest)

Specify this field if you want to add one or multiple subscription plans to this subscription.

Array of objects (SubscriptionRemovePlanPatchRequest)

Specify this field if you want to remove one or multiple subscription plans from this subscription.

Array of objects (SubscriptionReplacePlanPatchRequest)

Specify this field if you want to replace one or multiple subscription plans to this subscription.
Note: This field is currently not supported if you have Billing - Revenue Integration enabled. When Billing - Revenue Integration is enabled, the replace subscription plan type of order action will no longer be applicable in Zuora Billing.

Array of objects (SubscriptionUpdatePlanPatchRequest)
object (SubscriptionRenewPatchRequest)

Specify this field when renewing a subscription.

Array of objects (SubscriptionRenewPatchRequest)

Specify this field when renewing a subscription.

object (CancelSubscriptionRequest)
object or null (PauseSubscriptionRequest)
object (ResumeSubscriptionRequest)

Behavior of the paused subscription when it resumes.

bill_to_id
string or null

ID of the bill-to contact.

payment_terms
string or null

The name of payment term associated with the invoice.

object (FlexibleBillingDocumentSettings)

The billing document settings for the customer.

sold_to_id
string or null

ID of the sold-to contact.

invoice_separately
boolean

Separates a single subscription from other subscriptions and creates an invoice for this subscription. If the value is true, the subscription is billed separately from other subscriptions. If the value is false, the subscription is included with other subscriptions in the account invoice.

Responses
200

Default Response

400

Bad Request

401

Unauthorized

404

Not Found

405

Method Not Allowed

429

Too Many Requests

500

Internal Server Error

502

Bad Gateway

503

Service Unavailable

504

Gateway Timeout

post/subscriptions/{subscription_id}/keep
Request samples
application/json
{
  • "description": "string",
  • "custom_fields": { },
  • "terms": {
    },
  • "start_on": {
    },
  • "invoice_owner_account_id": "string",
  • "invoice_owner_account_number": "string",
  • "account_id": "string",
  • "account_number": "string",
  • "add_subscription_plans": [
    ],
  • "remove_subscription_plans": [
    ],
  • "replace_subscription_plans": [
    ],
  • "update_subscription_plans": [
    ],
  • "renew": {
    },
  • "renewals": [
    ],
  • "cancel": {
    },
  • "pause": {
    },
  • "resume": {
    },
  • "bill_to_id": "2c92c0f86a8dd422016a9e7a70116b0d",
  • "payment_terms": "string",
  • "billing_document_settings": {
    },
  • "sold_to_id": "2c92c0f86a8dd422016a9e7a70116b0d",
  • "invoice_separately": true
}
Response samples
application/json
{
  • "id": "8ad08ccf8437067601843a7af4e64rq3",
  • "custom_fields": {
    },
  • "subscription_number": "A-S0001332401234",
  • "state": "active",
  • "account_id": "2c92c0f86a8dd422016a9e7a70116b0d",
  • "invoice_owner_account_id": "2c92c0f86a8dd422016a9e7a70116b0d",
  • "auto_renew": true,
  • "latest_version": true,
  • "initial_term": {
    },
  • "current_term": {
    },
  • "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"
}