Pricing Templates
Log in Sign up
Integrations / Zuora / ...

POST /v1/sign-up

This call performs many actions. You can use this operation to implement the standard requirements for signing up a customer, such as validating the uniqueness of an account and limiting the number of subscriptions per account. Also, you can use this operation to create a subscription, generate an invoice, and collect payment for a new or existing customer.

Note: You need to have the Orders or Orders Harmonization feature enabled to use this API.

For a new customer, you can perform the following tasks in one call. Note that you can skip creating a payment meethod and still get the subscription and invoice successfully created.

For an existing customer, you can use an account identification field of an external system to specify the account.

You can make make asynchronous requests when using the "Sign up" operation.

Servers

Request headers

Name Type Required Description
Accept String No

Expressed as MIME types that the client is able to understand. Using content negotiation, the server then selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header. The possible response MIME types are application/json-seq compatible with http://jsonlines.org/, and text/csv compatible with RFC 4180. application/json-seq is the default response MIME type. If the Accept header is not sepecified, or set /, the response body is returned in application/json-seq MIME type.
Content-Type String Yes The media type of the request body.

Default value: "application/json"
Content-Encoding String No

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
Zuora-Track-Id String No

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora 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 ("), and quote (').
Authorization String Yes

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.
Idempotency-Key String No

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.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
Zuora-Entity-Ids String No

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
Zuora-Org-Ids String No

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.
Accept-Encoding String No

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Request body fields

Name Type Required Description
customFields Object No

Container for custom fields.
accountData Object No

The information of the account that you are to create through the "Sign up" operation.
accountData.creditMemoTemplateId String No

Note: This field is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information.

The unique ID of the credit memo template, configured in Billing Settings > Manage Billing Document Configuration through the Zuora UI. For example, 2c92c08a6246fdf101626b1b3fe0144b.
accountData.crmId String No
accountData.billCycleDay Integer Yes

Day of the month that the account prefers billing periods to begin on. If set to 0, the bill cycle day will be set as "AutoSet".
accountData.paymentTerm String No
accountData.invoiceTemplateId String No
accountData.purchaseOrderNumber String No

The number of the purchase order associated with this account. Purchase order information generally comes from customers.
accountData.sequenceSetId String No

The ID of the billing document sequence set to assign to the customer account.

The billing documents to generate for this account will adopt the prefix and starting document number configured in the sequence set.
accountData.currency String Yes

3 uppercase character currency code.

For payment method authorization, if the paymentMethod > currencyCode field is specified, currencyCode is used. Otherwise, this currency field is used for payment method authorization. If no currency is specified for the account, the default currency of the account is then used.
accountData.accountNumber String No
accountData.customFields Object No

Container for custom fields.
accountData.debitMemoTemplateId String No

Note: This field is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information.

The unique ID of the debit memo template, configured in Billing Settings > Manage Billing Document Configuration through the Zuora UI. For example, 2c92c08d62470a8501626b19d24f19e2.
accountData.name String Yes
accountData.communicationProfileId String No
accountData.notes String No
accountData.autoPay Boolean No

Specifies whether future payments are to be automatically billed when they are due. Possible values are true, false.
accountData.taxInfo Object No

Information about the tax exempt status of a customer account.
accountData.taxInfo.exemptCertificateType String No

Type of tax exemption certificate that the customer holds. Applicable if you use Zuora Tax or Connect tax engines.
accountData.taxInfo.VATId String No

EU Value Added Tax ID.

Note: This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support.
accountData.taxInfo.exemptCertificateId String No

ID of the customer tax exemption certificate. Applicable if you use Zuora Tax or Connect tax engines.
accountData.taxInfo.companyCode String No

Unique code that identifies a company account in Avalara. Use this field to calculate taxes based on origin and sold-to addresses in Avalara.

Note: This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support.
accountData.taxInfo.exemptIssuingJurisdiction String No

Jurisdiction in which the customer tax exemption certificate was issued.
accountData.taxInfo.exemptStatus String No

Status of the account tax exemption. Applicable if you use Zuora Tax or Connect tax engines. Required if you use Zuora Tax.

Possible values:

  • "PendingVerification"
  • "Yes"
  • "No"

Default value: "No"
accountData.taxInfo.exemptDescription String No

Description of the tax exemption certificate that the customer holds. Applicable if you use Zuora Tax or Connect tax engines.
accountData.taxInfo.exemptEffectiveDate String No

Date when the customer tax exemption starts, in YYYY-MM-DD format. Applicable if you use Zuora Tax or Connect tax engines.
accountData.taxInfo.exemptExpirationDate String No

Date when the customer tax exemption expires, in YYYY-MM-DD format. Applicable if you use Zuora Tax or Connect tax engines.
accountData.batch String No

Note: By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the Performance Booster Elite package.
options Object No

Invoice or Payment.
options.billingTargetDate String No

Date through which to calculate charges if an invoice is generated. See What is a Target Date?.
options.maxSubscriptionsPerAccount Number No
options.runBilling Boolean No

Indicates if the current request needs to generate an invoice. The invoice will be generated against all subscriptions included in this order.
options.collectPayment Boolean No

Indicates if the current request needs to collect payments. This value can not be 'true' when 'runBilling' flag is 'false'.
accountIdentifierField String No

Specify the name of the field that holds external account id
subscriptionData Object No
subscriptionData.customFields Object No

Container for custom fields.
subscriptionData.notes String No

Notes about the subscription. These notes are only visible to Zuora users.
subscriptionData.invoiceSeparately Boolean No

Specifies whether the subscription appears on a separate invoice when Zuora generates invoices.
subscriptionData.subscriptionNumber String No

Subscription number of the subscription to create, for example, A-S00000001.

If you do not set this field, Zuora will generate a subscription number.
subscriptionData.startDate String No
subscriptionData.ratePlans[] Array No
subscriptionData.ratePlans[].customFields Object No

Container for custom fields.
subscriptionData.ratePlans[].productRatePlanId String No

Internal identifier of the product rate plan that the rate plan is based on.
subscriptionData.terms Object No

Container for the terms and renewal settings of the subscription.
subscriptionData.terms.renewalSetting String No

Specifies the type of the terms that follow the first term if the subscription is renewed. Only applicable if the type of the first term is TERMED.

  • RENEW_WITH_SPECIFIC_TERM - Each renewal term has a predefined duration. The first entry in renewalTerms specifies the duration of the second term of the subscription, the second entry in renewalTerms specifies the duration of the third term of the subscription, and so on. The last entry in renewalTerms specifies the ultimate duration of each renewal term.
  • RENEW_TO_EVERGREEN - The second term of the subscription does not have a predefined duration.

Possible values:

  • "RENEW_TO_EVERGREEN"
  • "RENEW_WITH_SPECIFIC_TERM"
subscriptionData.terms.renewalTerms Object No
subscriptionData.terms.renewalTerms.period Integer No

Duration of the renewal term in months, years, days, or weeks, depending on the value of the periodType field.
subscriptionData.terms.renewalTerms.periodType String No

Unit of time that the renewal term is measured in.

Possible values:

  • "Week"
  • "Day"
  • "Year"
  • "Month"
subscriptionData.terms.autoRenew Boolean No

Specifies whether the subscription automatically renews at the end of the each term. Only applicable if the type of the first term is TERMED.
subscriptionData.terms.initialTerm Object Yes

Information about the first term of the subscription.
subscriptionData.terms.initialTerm.period Integer No

Duration of the first term in months, years, days, or weeks, depending on the value of the periodType field. Only applicable if the value of the termType field is TERMED.
subscriptionData.terms.initialTerm.termType String Yes

Type of the first term. If the value of this field is TERMED, the first term has a predefined duration based on the value of the period field. If the value of this field is EVERGREEN, the first term does not have a predefined duration.

Possible values:

  • "EVERGREEN"
  • "TERMED"
subscriptionData.terms.initialTerm.periodType String No

Unit of time that the first term is measured in. Only applicable if the value of the termType field is TERMED.

Possible values:

  • "Week"
  • "Day"
  • "Year"
  • "Month"
subscriptionData.terms.initialTerm.startDate String No

Start date of the first term, in YYYY-MM-DD format.
paymentData Object No
paymentData.authTransactionId String No

The authorization transaction ID from the payment gateway.
paymentData.authorizedCurrency String No

The authorization of currency code that occurs before this API call. We will verify whether it is same as the account's currency.
paymentData.authorizedAmount Number No

The amount that is authorized before this API call. Only used for the Delay Capture function.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2025 SimWorkflow
Terms of Service Privacy Policy