Zip and Country Codes
Development
Reference Materials
Introduction
Billing API is a RESTful API that allows setting up customers, collecting payments and maintaining balances for these customers, as well as creating recurring billing subscriptions.
Billing API documentation includes the following sections:
Objects - lists all recurring billing objects. The purpose of this section is to describe all object fields, their format and usage, provide the links to the corresponding database tables.
Type Enumerations – lists possible values that can be used in the respective fields within Billing API requests and responses. The purpose of this section is to provide an explanation of all enumerations used for API calls.
Actions - lists all actions that can be performed with key recurring billing objects. The purpose of this section is to describe the methods and format of API requests and the format of responses.
Integration Notes – lists integration notes associated with the Billing API objects and actions. The purpose of this section is to provide explicit information about the peculiarities of specific actions and object fields.
Code samples - provides examples of recurring billing use cases (creating billing plans, subscriptions, freeing or canceling subscriptions, reversing transactions, etc) and their implementation in JSON, XML formats. The purpose of this section is to provide examples that can be used for testing of the integration with the gateway.
To learn how to work with the Billing API, we recommend reviewing the integration notes first. Key recurring billing module terms are available here.
For more detailed information about the recurring billing configurations and management, check the Recurring Billing Guide.
Billing API Index (Actions)
URL |
Action |
Method |
[version]/customers view |
[version]/customers |
~create |
PUT |
[version]/customers |
~find |
GET |
[version]/customers/[customer-id] view |
[version]/customers/[customer-id] |
~load |
GET |
[version]/customers/[customer-id] |
~modify |
POST |
[version]/customers/[customer-id]/payment-options view |
[version]/customers/[customer-id]/payment-options |
~create |
PUT |
[version]/customers/[customer-id]/payment-options |
~find |
GET |
[version]/customers/[customer-id]/payment-options/[payment-option-id] view |
[version]/customers/[customer-id]/payment-options/[payment-option-id] |
~load |
GET |
[version]/customers/[customer-id]/payment-options/[payment-option-id] |
~modify |
POST |
[version]/customers/[customer-id]/payment-options/[payment-option-id] |
~process |
POST |
[version]/customers/[customer-id]/subscriptions view |
[version]/customers/[customer-id]/subscriptions |
~create |
PUT |
[version]/customers/[customer-id]/subscriptions |
~find |
GET |
[version]/customers/[customer-id]/subscriptions/[subscription-id] view |
[version]/customers/[customer-id]/subscriptions/[subscription-id] |
~cancel |
GET |
[version]/customers/[customer-id]/subscriptions/[subscription-id] |
~freeze |
GET |
[version]/customers/[customer-id]/subscriptions/[subscription-id] |
~load |
GET |
[version]/customers/[customer-id]/subscriptions/[subscription-id] |
~modify |
POST |
[version]/customers/[customer-id]/subscriptions/[subscription-id] |
~pause |
GET |
[version]/customers/[customer-id]/subscriptions/[subscription-id] |
~uncancel |
GET |
[version]/customers/[customer-id]/subscriptions/[subscription-id] |
~unfreeze |
GET |
[version]/customers/[customer-id]/subscriptions/[subscription-id] |
~unpause |
GET |
[version]/customers/[customer-id]/subscriptions/[subscription-id]/adjustments view |
[version]/customers/[customer-id]/subscriptions/[subscription-id]/adjustments |
~find |
GET |
[version]/customers/[customer-id]/transactions view |
[version]/customers/[customer-id]/transactions |
~create |
PUT |
[version]/customers/[customer-id]/transactions |
~find |
GET |
[version]/customers/[customer-id]/transactions |
~process |
POST |
[version]/customers/[customer-id]/transactions/[transaction-id] view |
[version]/customers/[customer-id]/transactions/[transaction-id] |
~load |
GET |
[version]/customers/[customer-id]/transactions/[transaction-id] |
~reverse |
GET |
[version]/customers/[customer-id]/transactions/[transaction-id]/allocations view |
[version]/customers/[customer-id]/transactions/[transaction-id]/allocations |
~find |
GET |
[version]/plans view |
[version]/plans |
~create |
PUT |
[version]/plans |
~find |
GET |
[version]/plans/[plan-id] view |
[version]/plans/[plan-id] |
~load |
GET |
[version]/plans/[plan-id] |
~modify |
POST |
Base Resource URL:
https://[server-name]/api/v01/customers/[customer-id]/subscriptions/[subscription-id]
Description:
Allows to manage the specified subscription.
Supported sub-resources:
Resource URL |
Description |
https://[server-name]/api/v01/customers/[customer-id]/subscriptions/[subscription-id]/adjustments
|
Provides access to the adjustments associated with the specified subscription. |
Supported Actions:
~cancel (request)
Consumes: xurl
Produces: json,xml,xurl
Cancels the subscription right away or on the specified date.
# |
Name |
Type |
Pattern |
Format |
Mode |
Usage |
Description |
1 |
customer-id |
Long |
|
|
|
|
System-generated unique identifier for the customer.\n\r\n> **Note:** Automatically generated by the system. This field must not be provided in your request. |
2 |
subscription-id |
Long |
|
|
|
|
Unique Subscription ID generated by the system. |
# |
Name |
Type |
Pattern |
Format |
Mode |
Usage |
Description |
1 |
effectiveDate |
Date |
|
|
|
|
Date when the subscription is going to be canceled. |
2 |
note |
String |
|
|
|
|
Any notes related to the cancelation of the subscription. |
~cancel (response)
Consumes: xurl
Produces: json,xml,xurl
Cancels the subscription right away or on the specified date.
# |
Name |
Type |
Pattern |
Format |
Mode |
Usage |
Description |
1 |
pendingAdjustmentType
|
|
|
|
|
|
Type of scheduled change to be applied to this subscription.\n\r\n> **Note:** This field is only included if a future adjustment has been scheduled.\n\r\n> **Tip:** Common values include F (Freeze), C (Cancel), or P (Pause). |
2 |
firstInvoicingDate
|
Date |
|
|
|
|
Date when the first invoice will be generated for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if invoicing is configured separately from billing. |
3 |
nextInvoicingDate
|
Date |
|
|
|
|
Date when the next invoice will be generated for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if relevant to the subscription's current state. |
4 |
taxAmount
|
Integer |
|
|
|
|
Tax amount (in cents) that will be applied to each billing cycle.\n\r\n> **Note:** This field is only included if tax calculation is enabled for this subscription. |
5 |
planName
|
String(255) |
|
|
|
|
Name of the payment plan associated with this subscription.\n\r\n> **Note:** This value is derived from the referenced planId and provides a human-readable identifier. |
6 |
billingCycleType
|
|
|
|
|
|
Frequency at which the customer will be billed for this subscription.\n\r\n> **Note:** Common values include M (Monthly), A (Annual), Q (Quarterly), etc. |
7 |
code
|
String(60) |
|
|
|
|
Secondary identifier for the subscription that references an ID in your own system.\n\r\n> **Note:** If you didn't provide a value in the request, this will be set to the same value as the id field.\n\r\n> **Tip:** Use this field to cross-reference subscriptions between systems. |
8 |
createDate
|
Datetime |
|
|
|
|
Date and time when the subscription was created in the system.\n\r\n> **Note:** This value is returned in yyyy-MM-dd HH:mm:ss format. |
9 |
firstBillingDate
|
Date |
|
|
|
|
Date when the first billing for this subscription will occur.\n\r\n> **Note:** Format must be yyyy-MM-dd. This date establishes the billing cycle start date. |
10 |
id
|
Long |
|
|
|
|
System-generated unique identifier for the newly created subscription.\n\r\n> **Note:** Use this identifier in subsequent API calls when referencing this subscription.\n\r\n> **Tip:** Store this value in your system for future subscription management operations. |
11 |
lastBillingDate
|
Date |
|
|
|
|
Final date when billing will occur for this subscription.\n\r\n> **Note:** This field is only included for subscriptions with type=F (Fixed). Format must be yyyy-MM-dd. |
12 |
lastUpdateDate
|
Datetime |
|
|
|
|
Date and time when the subscription was last modified.\n\r\n> **Note:** This value is returned in yyyy-MM-dd HH:mm:ss format. Matches createDate for newly created subscriptions. |
13 |
pendingAdjustmentEffectiveDate
|
Date |
|
|
|
|
Date when the scheduled change will take effect.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if pendingAdjustmentType is present. |
14 |
pendingAdjustmentLength
|
Integer |
|
|
|
|
Number of billing cycles for which the adjustment will apply.\n\r\n> **Note:** This field is only included if pendingAdjustmentType is F (Freeze). |
15 |
pendingAdjustmentNote
|
String(255) |
|
|
|
|
Additional information about the scheduled adjustment.\n\r\n> **Note:** This field is only included if pendingAdjustmentType is present. |
16 |
planId
|
Reference |
|
|
|
|
Reference to the payment plan this subscription is based on.\n\r\n> **Note:** The plan defines the base pricing and billing terms for this subscription. |
17 |
status
|
|
|
|
|
|
Current status of the subscription in the system.\n\r\n> **Note:** For new subscriptions, this is typically set to "Current" or "Unbilled" depending on the billing schedule. |
18 |
id
|
Long |
|
|
|
|
System-generated unique identifier for the newly created subscription.\n\r\n> **Note:** Use this identifier in subsequent API calls when referencing this subscription.\n\r\n> **Tip:** Store this value in your system for future subscription management operations. |
19 |
accountId
|
Integer |
|
|
|
|
Identifier of the merchant account under which this subscription was created.\n\r\n> **Note:** This indicates which merchant account is managing this subscription. |
20 |
amount
|
Integer |
|
|
|
|
Amount (in cents) that will be charged for each billing cycle of this subscription.\n\r\n> **Note:** For example, $10.00 would be represented as 1000. |
21 |
createDate
|
Datetime |
|
|
|
|
Date and time when the subscription was created in the system.\n\r\n> **Note:** This value is returned in yyyy-MM-dd HH:mm:ss format. |
22 |
customerId
|
Long |
|
|
|
|
Identifier of the customer for whom the subscription is being created.\n\r\n> **Tip:** Use this to retrieve customer details or to group all subscriptions for a particular customer. |
23 |
firstBillingDate
|
Date |
|
|
|
|
Date when the first billing for this subscription will occur.\n\r\n> **Note:** Format must be yyyy-MM-dd. This date establishes the billing cycle start date. |
24 |
lastBillingDate
|
Date |
|
|
|
|
Final date when billing will occur for this subscription.\n\r\n> **Note:** This field is only included for subscriptions with type=F (Fixed). Format must be yyyy-MM-dd. |
25 |
lastUpdateDate
|
Datetime |
|
|
|
|
Date and time when the subscription was last modified.\n\r\n> **Note:** This value is returned in yyyy-MM-dd HH:mm:ss format. Matches createDate for newly created subscriptions. |
26 |
length
|
Integer |
|
|
|
|
Number of billing cycles for which the subscription will be active.\n\r\n> **Note:** This field is only included for subscriptions with type=F (Fixed). The maximum value depends on the billingCycleType: A (Annual) - 3, S (Semi-annual) - 6, Q (Quarterly) - 12, M (Monthly) - 36, W (Weekly) - 153. |
27 |
nextBillingDate
|
Date |
|
|
|
|
Date when the next billing will occur for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This value is automatically calculated based on the billing cycle and the firstBillingDate. |
28 |
note
|
String(255) |
|
|
|
|
Additional information or comments about this subscription.\n\r\n> **Note:** This field is only included if a note was provided in the request. |
29 |
paymentOptionId
|
Reference |
|
|
|
|
Reference to the customer's payment method that will be used to collect subscription payments.\n\r\n> **Note:** This is the payment method that will be charged according to the subscription schedule. |
30 |
planId
|
Reference |
|
|
|
|
Reference to the payment plan this subscription is based on.\n\r\n> **Note:** The plan defines the base pricing and billing terms for this subscription. |
31 |
status
|
|
|
|
|
|
Current status of the subscription in the system.\n\r\n> **Note:** For new subscriptions, this is typically set to "Current" or "Unbilled" depending on the billing schedule. |
32 |
type
|
|
|
|
|
|
Type of subscription - either fixed-term or perpetual (ongoing).\n\r\n> **Note:** F (Fixed) indicates a subscription with a defined end date, while P (Perpetual) indicates an ongoing subscription. |
33 |
billingCycleType
|
|
|
|
|
|
Frequency at which the customer will be billed for this subscription.\n\r\n> **Note:** Common values include M (Monthly), A (Annual), Q (Quarterly), etc. |
34 |
pendingAdjustmentEffectiveDate
|
Date |
|
|
|
|
Date when the scheduled change will take effect.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if pendingAdjustmentType is present. |
35 |
pendingAdjustmentNote
|
String(255) |
|
|
|
|
Additional information about the scheduled adjustment.\n\r\n> **Note:** This field is only included if pendingAdjustmentType is present. |
36 |
pendingAdjustmentLength
|
Integer |
|
|
|
|
Number of billing cycles for which the adjustment will apply.\n\r\n> **Note:** This field is only included if pendingAdjustmentType is F (Freeze). |
37 |
code
|
String(60) |
|
|
|
|
Secondary identifier for the subscription that references an ID in your own system.\n\r\n> **Note:** If you didn't provide a value in the request, this will be set to the same value as the id field.\n\r\n> **Tip:** Use this field to cross-reference subscriptions between systems. |
38 |
planName
|
String |
|
|
|
|
Name of the payment plan associated with this subscription.\n\r\n> **Note:** This value is derived from the referenced planId and provides a human-readable identifier. |
39 |
nextInvoicingDate
|
Date |
|
|
|
|
Date when the next invoice will be generated for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if relevant to the subscription's current state. |
40 |
firstInvoicingDate
|
Date |
|
|
|
|
Date when the first invoice will be generated for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if invoicing is configured separately from billing. |
41 |
taxAmount
|
Integer |
|
|
|
|
Tax amount (in cents) that will be applied to each billing cycle.\n\r\n> **Note:** This field is only included if tax calculation is enabled for this subscription. |
42 |
planName
|
String |
|
|
|
|
Name of the payment plan associated with this subscription.\n\r\n> **Note:** This value is derived from the referenced planId and provides a human-readable identifier. |
~freeze (request)
Consumes: xurl
Produces: json,xml,xurl
Freezes the subscription for the specified period.
# |
Name |
Type |
Pattern |
Format |
Mode |
Usage |
Description |
1 |
customer-id |
Long |
|
|
|
|
System-generated unique identifier for the customer.\n\r\n> **Note:** Automatically generated by the system. This field must not be provided in your request. |
2 |
subscription-id |
Long |
|
|
|
|
Unique Subscription ID generated by the system. |
# |
Name |
Type |
Pattern |
Format |
Mode |
Usage |
Description |
1 |
effectiveDate |
Date |
|
|
|
|
Date when the subscription is going to be frozen. The date must be in future and correspond to the subscription billing date. |
2 |
length |
Integer |
|
|
|
|
Number of the payments for which the subscription is going to be frozen. |
3 |
note |
String |
|
|
|
|
Any notes related to the freeze of the subscription. |
~freeze (response)
Consumes: xurl
Produces: json,xml,xurl
Freezes the subscription for the specified period.
# |
Name |
Type |
Pattern |
Format |
Mode |
Usage |
Description |
1 |
pendingAdjustmentType
|
|
|
|
|
|
Type of scheduled change to be applied to this subscription.\n\r\n> **Note:** This field is only included if a future adjustment has been scheduled.\n\r\n> **Tip:** Common values include F (Freeze), C (Cancel), or P (Pause). |
2 |
firstInvoicingDate
|
Date |
|
|
|
|
Date when the first invoice will be generated for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if invoicing is configured separately from billing. |
3 |
nextInvoicingDate
|
Date |
|
|
|
|
Date when the next invoice will be generated for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if relevant to the subscription's current state. |
4 |
taxAmount
|
Integer |
|
|
|
|
Tax amount (in cents) that will be applied to each billing cycle.\n\r\n> **Note:** This field is only included if tax calculation is enabled for this subscription. |
5 |
planName
|
String(255) |
|
|
|
|
Name of the payment plan associated with this subscription.\n\r\n> **Note:** This value is derived from the referenced planId and provides a human-readable identifier. |
6 |
billingCycleType
|
|
|
|
|
|
Frequency at which the customer will be billed for this subscription.\n\r\n> **Note:** Common values include M (Monthly), A (Annual), Q (Quarterly), etc. |
7 |
code
|
String(60) |
|
|
|
|
Secondary identifier for the subscription that references an ID in your own system.\n\r\n> **Note:** If you didn't provide a value in the request, this will be set to the same value as the id field.\n\r\n> **Tip:** Use this field to cross-reference subscriptions between systems. |
8 |
createDate
|
Datetime |
|
|
|
|
Date and time when the subscription was created in the system.\n\r\n> **Note:** This value is returned in yyyy-MM-dd HH:mm:ss format. |
9 |
firstBillingDate
|
Date |
|
|
|
|
Date when the first billing for this subscription will occur.\n\r\n> **Note:** Format must be yyyy-MM-dd. This date establishes the billing cycle start date. |
10 |
id
|
Long |
|
|
|
|
System-generated unique identifier for the newly created subscription.\n\r\n> **Note:** Use this identifier in subsequent API calls when referencing this subscription.\n\r\n> **Tip:** Store this value in your system for future subscription management operations. |
11 |
lastBillingDate
|
Date |
|
|
|
|
Final date when billing will occur for this subscription.\n\r\n> **Note:** This field is only included for subscriptions with type=F (Fixed). Format must be yyyy-MM-dd. |
12 |
lastUpdateDate
|
Datetime |
|
|
|
|
Date and time when the subscription was last modified.\n\r\n> **Note:** This value is returned in yyyy-MM-dd HH:mm:ss format. Matches createDate for newly created subscriptions. |
13 |
pendingAdjustmentEffectiveDate
|
Date |
|
|
|
|
Date when the scheduled change will take effect.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if pendingAdjustmentType is present. |
14 |
pendingAdjustmentLength
|
Integer |
|
|
|
|
Number of billing cycles for which the adjustment will apply.\n\r\n> **Note:** This field is only included if pendingAdjustmentType is F (Freeze). |
15 |
pendingAdjustmentNote
|
String(255) |
|
|
|
|
Additional information about the scheduled adjustment.\n\r\n> **Note:** This field is only included if pendingAdjustmentType is present. |
16 |
planId
|
Reference |
|
|
|
|
Reference to the payment plan this subscription is based on.\n\r\n> **Note:** The plan defines the base pricing and billing terms for this subscription. |
17 |
status
|
|
|
|
|
|
Current status of the subscription in the system.\n\r\n> **Note:** For new subscriptions, this is typically set to "Current" or "Unbilled" depending on the billing schedule. |
18 |
id
|
Long |
|
|
|
|
System-generated unique identifier for the newly created subscription.\n\r\n> **Note:** Use this identifier in subsequent API calls when referencing this subscription.\n\r\n> **Tip:** Store this value in your system for future subscription management operations. |
19 |
accountId
|
Integer |
|
|
|
|
Identifier of the merchant account under which this subscription was created.\n\r\n> **Note:** This indicates which merchant account is managing this subscription. |
20 |
amount
|
Integer |
|
|
|
|
Amount (in cents) that will be charged for each billing cycle of this subscription.\n\r\n> **Note:** For example, $10.00 would be represented as 1000. |
21 |
createDate
|
Datetime |
|
|
|
|
Date and time when the subscription was created in the system.\n\r\n> **Note:** This value is returned in yyyy-MM-dd HH:mm:ss format. |
22 |
customerId
|
Long |
|
|
|
|
Identifier of the customer for whom the subscription is being created.\n\r\n> **Tip:** Use this to retrieve customer details or to group all subscriptions for a particular customer. |
23 |
firstBillingDate
|
Date |
|
|
|
|
Date when the first billing for this subscription will occur.\n\r\n> **Note:** Format must be yyyy-MM-dd. This date establishes the billing cycle start date. |
24 |
lastBillingDate
|
Date |
|
|
|
|
Final date when billing will occur for this subscription.\n\r\n> **Note:** This field is only included for subscriptions with type=F (Fixed). Format must be yyyy-MM-dd. |
25 |
lastUpdateDate
|
Datetime |
|
|
|
|
Date and time when the subscription was last modified.\n\r\n> **Note:** This value is returned in yyyy-MM-dd HH:mm:ss format. Matches createDate for newly created subscriptions. |
26 |
length
|
Integer |
|
|
|
|
Number of billing cycles for which the subscription will be active.\n\r\n> **Note:** This field is only included for subscriptions with type=F (Fixed). The maximum value depends on the billingCycleType: A (Annual) - 3, S (Semi-annual) - 6, Q (Quarterly) - 12, M (Monthly) - 36, W (Weekly) - 153. |
27 |
nextBillingDate
|
Date |
|
|
|
|
Date when the next billing will occur for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This value is automatically calculated based on the billing cycle and the firstBillingDate. |
28 |
note
|
String(255) |
|
|
|
|
Additional information or comments about this subscription.\n\r\n> **Note:** This field is only included if a note was provided in the request. |
29 |
paymentOptionId
|
Reference |
|
|
|
|
Reference to the customer's payment method that will be used to collect subscription payments.\n\r\n> **Note:** This is the payment method that will be charged according to the subscription schedule. |
30 |
planId
|
Reference |
|
|
|
|
Reference to the payment plan this subscription is based on.\n\r\n> **Note:** The plan defines the base pricing and billing terms for this subscription. |
31 |
status
|
|
|
|
|
|
Current status of the subscription in the system.\n\r\n> **Note:** For new subscriptions, this is typically set to "Current" or "Unbilled" depending on the billing schedule. |
32 |
type
|
|
|
|
|
|
Type of subscription - either fixed-term or perpetual (ongoing).\n\r\n> **Note:** F (Fixed) indicates a subscription with a defined end date, while P (Perpetual) indicates an ongoing subscription. |
33 |
billingCycleType
|
|
|
|
|
|
Frequency at which the customer will be billed for this subscription.\n\r\n> **Note:** Common values include M (Monthly), A (Annual), Q (Quarterly), etc. |
34 |
pendingAdjustmentEffectiveDate
|
Date |
|
|
|
|
Date when the scheduled change will take effect.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if pendingAdjustmentType is present. |
35 |
pendingAdjustmentNote
|
String(255) |
|
|
|
|
Additional information about the scheduled adjustment.\n\r\n> **Note:** This field is only included if pendingAdjustmentType is present. |
36 |
pendingAdjustmentLength
|
Integer |
|
|
|
|
Number of billing cycles for which the adjustment will apply.\n\r\n> **Note:** This field is only included if pendingAdjustmentType is F (Freeze). |
37 |
code
|
String(60) |
|
|
|
|
Secondary identifier for the subscription that references an ID in your own system.\n\r\n> **Note:** If you didn't provide a value in the request, this will be set to the same value as the id field.\n\r\n> **Tip:** Use this field to cross-reference subscriptions between systems. |
38 |
planName
|
String |
|
|
|
|
Name of the payment plan associated with this subscription.\n\r\n> **Note:** This value is derived from the referenced planId and provides a human-readable identifier. |
39 |
nextInvoicingDate
|
Date |
|
|
|
|
Date when the next invoice will be generated for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if relevant to the subscription's current state. |
40 |
firstInvoicingDate
|
Date |
|
|
|
|
Date when the first invoice will be generated for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if invoicing is configured separately from billing. |
41 |
taxAmount
|
Integer |
|
|
|
|
Tax amount (in cents) that will be applied to each billing cycle.\n\r\n> **Note:** This field is only included if tax calculation is enabled for this subscription. |
42 |
planName
|
String |
|
|
|
|
Name of the payment plan associated with this subscription.\n\r\n> **Note:** This value is derived from the referenced planId and provides a human-readable identifier. |
~load (request)
Method: GET
Implicit: Yes
Consumes: xurl
Produces: json,xml
Returns settings of the subscription specified in the request.
# |
Name |
Type |
Pattern |
Format |
Mode |
Usage |
Description |
1 |
customer-id |
Long |
|
|
|
|
System-generated unique identifier for the customer.\n\r\n> **Note:** Automatically generated by the system. This field must not be provided in your request. |
2 |
subscription-id |
Long |
|
|
|
|
Unique Subscription ID generated by the system. |
~load (response)
Method: GET
Implicit: Yes
Consumes: xurl
Produces: json,xml
Returns settings of the subscription specified in the request.
# |
Name |
Type |
Pattern |
Format |
Mode |
Usage |
Description |
1 |
pendingAdjustmentType
|
|
|
|
|
|
Type of scheduled change to be applied to this subscription.\n\r\n> **Note:** This field is only included if a future adjustment has been scheduled.\n\r\n> **Tip:** Common values include F (Freeze), C (Cancel), or P (Pause). |
2 |
firstInvoicingDate
|
Date |
|
|
|
|
Date when the first invoice will be generated for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if invoicing is configured separately from billing. |
3 |
nextInvoicingDate
|
Date |
|
|
|
|
Date when the next invoice will be generated for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if relevant to the subscription's current state. |
4 |
taxAmount
|
Integer |
|
|
|
|
Tax amount (in cents) that will be applied to each billing cycle.\n\r\n> **Note:** This field is only included if tax calculation is enabled for this subscription. |
5 |
planName
|
String(255) |
|
|
|
|
Name of the payment plan associated with this subscription.\n\r\n> **Note:** This value is derived from the referenced planId and provides a human-readable identifier. |
6 |
billingCycleType
|
|
|
|
|
|
Frequency at which the customer will be billed for this subscription.\n\r\n> **Note:** Common values include M (Monthly), A (Annual), Q (Quarterly), etc. |
7 |
code
|
String(60) |
|
|
|
|
Secondary identifier for the subscription that references an ID in your own system.\n\r\n> **Note:** If you didn't provide a value in the request, this will be set to the same value as the id field.\n\r\n> **Tip:** Use this field to cross-reference subscriptions between systems. |
8 |
createDate
|
Datetime |
|
|
|
|
Date and time when the subscription was created in the system.\n\r\n> **Note:** This value is returned in yyyy-MM-dd HH:mm:ss format. |
9 |
firstBillingDate
|
Date |
|
|
|
|
Date when the first billing for this subscription will occur.\n\r\n> **Note:** Format must be yyyy-MM-dd. This date establishes the billing cycle start date. |
10 |
id
|
Long |
|
|
|
|
System-generated unique identifier for the newly created subscription.\n\r\n> **Note:** Use this identifier in subsequent API calls when referencing this subscription.\n\r\n> **Tip:** Store this value in your system for future subscription management operations. |
11 |
lastBillingDate
|
Date |
|
|
|
|
Final date when billing will occur for this subscription.\n\r\n> **Note:** This field is only included for subscriptions with type=F (Fixed). Format must be yyyy-MM-dd. |
12 |
lastUpdateDate
|
Datetime |
|
|
|
|
Date and time when the subscription was last modified.\n\r\n> **Note:** This value is returned in yyyy-MM-dd HH:mm:ss format. Matches createDate for newly created subscriptions. |
13 |
pendingAdjustmentEffectiveDate
|
Date |
|
|
|
|
Date when the scheduled change will take effect.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if pendingAdjustmentType is present. |
14 |
pendingAdjustmentLength
|
Integer |
|
|
|
|
Number of billing cycles for which the adjustment will apply.\n\r\n> **Note:** This field is only included if pendingAdjustmentType is F (Freeze). |
15 |
pendingAdjustmentNote
|
String(255) |
|
|
|
|
Additional information about the scheduled adjustment.\n\r\n> **Note:** This field is only included if pendingAdjustmentType is present. |
16 |
planId
|
Reference |
|
|
|
|
Reference to the payment plan this subscription is based on.\n\r\n> **Note:** The plan defines the base pricing and billing terms for this subscription. |
17 |
status
|
|
|
|
|
|
Current status of the subscription in the system.\n\r\n> **Note:** For new subscriptions, this is typically set to "Current" or "Unbilled" depending on the billing schedule. |
18 |
id
|
Long |
|
|
|
|
System-generated unique identifier for the newly created subscription.\n\r\n> **Note:** Use this identifier in subsequent API calls when referencing this subscription.\n\r\n> **Tip:** Store this value in your system for future subscription management operations. |
19 |
accountId
|
Integer |
|
|
|
|
Identifier of the merchant account under which this subscription was created.\n\r\n> **Note:** This indicates which merchant account is managing this subscription. |
20 |
amount
|
Integer |
|
|
|
|
Amount (in cents) that will be charged for each billing cycle of this subscription.\n\r\n> **Note:** For example, $10.00 would be represented as 1000. |
21 |
createDate
|
Datetime |
|
|
|
|
Date and time when the subscription was created in the system.\n\r\n> **Note:** This value is returned in yyyy-MM-dd HH:mm:ss format. |
22 |
customerId
|
Long |
|
|
|
|
Identifier of the customer for whom the subscription is being created.\n\r\n> **Tip:** Use this to retrieve customer details or to group all subscriptions for a particular customer. |
23 |
firstBillingDate
|
Date |
|
|
|
|
Date when the first billing for this subscription will occur.\n\r\n> **Note:** Format must be yyyy-MM-dd. This date establishes the billing cycle start date. |
24 |
lastBillingDate
|
Date |
|
|
|
|
Final date when billing will occur for this subscription.\n\r\n> **Note:** This field is only included for subscriptions with type=F (Fixed). Format must be yyyy-MM-dd. |
25 |
lastUpdateDate
|
Datetime |
|
|
|
|
Date and time when the subscription was last modified.\n\r\n> **Note:** This value is returned in yyyy-MM-dd HH:mm:ss format. Matches createDate for newly created subscriptions. |
26 |
length
|
Integer |
|
|
|
|
Number of billing cycles for which the subscription will be active.\n\r\n> **Note:** This field is only included for subscriptions with type=F (Fixed). The maximum value depends on the billingCycleType: A (Annual) - 3, S (Semi-annual) - 6, Q (Quarterly) - 12, M (Monthly) - 36, W (Weekly) - 153. |
27 |
nextBillingDate
|
Date |
|
|
|
|
Date when the next billing will occur for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This value is automatically calculated based on the billing cycle and the firstBillingDate. |
28 |
note
|
String(255) |
|
|
|
|
Additional information or comments about this subscription.\n\r\n> **Note:** This field is only included if a note was provided in the request. |
29 |
paymentOptionId
|
Reference |
|
|
|
|
Reference to the customer's payment method that will be used to collect subscription payments.\n\r\n> **Note:** This is the payment method that will be charged according to the subscription schedule. |
30 |
planId
|
Reference |
|
|
|
|
Reference to the payment plan this subscription is based on.\n\r\n> **Note:** The plan defines the base pricing and billing terms for this subscription. |
31 |
status
|
|
|
|
|
|
Current status of the subscription in the system.\n\r\n> **Note:** For new subscriptions, this is typically set to "Current" or "Unbilled" depending on the billing schedule. |
32 |
type
|
|
|
|
|
|
Type of subscription - either fixed-term or perpetual (ongoing).\n\r\n> **Note:** F (Fixed) indicates a subscription with a defined end date, while P (Perpetual) indicates an ongoing subscription. |
33 |
billingCycleType
|
|
|
|
|
|
Frequency at which the customer will be billed for this subscription.\n\r\n> **Note:** Common values include M (Monthly), A (Annual), Q (Quarterly), etc. |
34 |
pendingAdjustmentEffectiveDate
|
Date |
|
|
|
|
Date when the scheduled change will take effect.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if pendingAdjustmentType is present. |
35 |
pendingAdjustmentNote
|
String(255) |
|
|
|
|
Additional information about the scheduled adjustment.\n\r\n> **Note:** This field is only included if pendingAdjustmentType is present. |
36 |
pendingAdjustmentLength
|
Integer |
|
|
|
|
Number of billing cycles for which the adjustment will apply.\n\r\n> **Note:** This field is only included if pendingAdjustmentType is F (Freeze). |
37 |
code
|
String(60) |
|
|
|
|
Secondary identifier for the subscription that references an ID in your own system.\n\r\n> **Note:** If you didn't provide a value in the request, this will be set to the same value as the id field.\n\r\n> **Tip:** Use this field to cross-reference subscriptions between systems. |
38 |
planName
|
String |
|
|
|
|
Name of the payment plan associated with this subscription.\n\r\n> **Note:** This value is derived from the referenced planId and provides a human-readable identifier. |
39 |
nextInvoicingDate
|
Date |
|
|
|
|
Date when the next invoice will be generated for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if relevant to the subscription's current state. |
40 |
firstInvoicingDate
|
Date |
|
|
|
|
Date when the first invoice will be generated for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if invoicing is configured separately from billing. |
41 |
taxAmount
|
Integer |
|
|
|
|
Tax amount (in cents) that will be applied to each billing cycle.\n\r\n> **Note:** This field is only included if tax calculation is enabled for this subscription. |
42 |
planName
|
String |
|
|
|
|
Name of the payment plan associated with this subscription.\n\r\n> **Note:** This value is derived from the referenced planId and provides a human-readable identifier. |
~modify (request)
Method: POST
Implicit: Yes
Consumes: json,xml
Produces: json,xml
Updates the subscription with the specified values of the ''note'' and ''paymentOptionId'' fields.
# |
Name |
Type |
Pattern |
Format |
Mode |
Usage |
Description |
1 |
customer-id |
Long |
|
|
|
|
System-generated unique identifier for the customer.\n\r\n> **Note:** Automatically generated by the system. This field must not be provided in your request. |
2 |
subscription-id |
Long |
|
|
|
|
Unique Subscription ID generated by the system. |
# |
Name |
Type |
Pattern |
Format |
Mode |
Usage |
Description |
2 |
firstInvoicingDate |
Date |
|
|
|
|
Date when the first invoice will be generated for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This may differ from firstBillingDate if you want to generate invoices before collecting payment. |
3 |
nextInvoicingDate |
Date |
|
|
|
|
Date when the next invoice will be generated for this subscription.\n\r\n> **Note:** This field is typically calculated by the system rather than provided in the request. |
4 |
taxAmount |
Integer |
|
|
|
|
Tax amount (in cents) to be applied to each billing cycle.\n\r\n> **Note:** This is typically derived from the referenced plan and does not need to be explicitly provided. |
6 |
billingCycleType |
|
|
|
|
|
Frequency at which the customer will be billed for this subscription.\n\r\n> **Note:** Default: `M` (Monthly). Other options include A (Annual), S (Semi-annual), Q (Quarterly), and W (Weekly).\n\r\n> **Tip:** This typically should match the billing cycle type defined in the referenced plan. |
7 |
code |
String(60) |
|
|
|
|
Optional secondary identifier for the subscription that references an ID in your own system.\n\r\n> **Note:** If not provided, this value will default to the subscription's system-generated ID returned in the response.\n\r\n> **Tip:** Use this field to facilitate cross-referencing between systems and simplify reconciliation processes. |
9 |
firstBillingDate |
Date |
|
|
|
|
Date when the first billing for this subscription should occur.\n\r\n> **Note:** Format must be yyyy-MM-dd. This date determines the billing cycle start date for recurring charges. |
13 |
pendingAdjustmentEffectiveDate |
Date |
|
|
|
|
Date when the scheduled change will take effect. This field is required when pendingAdjustmentType is provided.\n\r\n> **Note:** Format must be yyyy-MM-dd. |
15 |
pendingAdjustmentNote |
String(255) |
|
|
|
|
Additional information about the scheduled adjustment. This field is required if any of the pendingAdjustment fields are provided.\n\r\n> **Note:** Maximum length is 255 characters. |
16 |
planId |
Reference |
|
|
|
|
Reference to the payment plan the customer is subscribing to.\n\r\n> **Note:** This must be a valid payment plan ID already created in the system.\n\r\n> **Tip:** The referenced plan determines the billing amount and available billing cycle options. |
19 |
accountId |
Integer |
|
|
|
|
Reference to the merchant account under which this subscription will be created.\n\r\n> **Note:** Your API credentials may be associated with more than one accountId. |
20 |
amount |
Integer |
|
|
|
|
Amount (in cents) to charge for each billing cycle of this subscription.\n\r\n> **Note:** This is typically derived from the referenced plan and does not need to be explicitly provided. |
22 |
customerId |
Long |
|
|
|
|
Identifier of the customer for whom the subscription is being created.\n\r\n> **Note:** This is derived from the customer-id field and typically does not need to be explicitly provided. |
23 |
firstBillingDate |
Date |
|
|
|
|
Date when the first billing for this subscription should occur.\n\r\n> **Note:** Format must be yyyy-MM-dd. This date determines the billing cycle start date for recurring charges. |
26 |
length |
Integer |
|
|
|
|
Number of billing cycles for which the subscription will be active. This field is required only when type is set to F (Fixed). Must not exceed the following maximum values, depending on billingCycleType: A (Annual) - 3, S (Semi-annual) - 6, Q (Quarterly) - 12, M (Monthly) - 36, W (Weekly) - 153.\n\r\n> **Tip:** For subscriptions longer than 3 years, use Perpetual (P) subscription type. |
27 |
nextBillingDate |
Date |
|
|
|
|
Date when the next billing will occur for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is typically calculated by the system based on the billing cycle. |
28 |
note |
String(255) |
|
|
|
|
Additional information or comments about this subscription.\n\r\n> **Note:** Maximum length is 255 characters.\n\r\n> **Tip:** Use this field to store customer-specific details related to the subscription for internal reference. |
29 |
paymentOptionId |
Reference |
|
|
|
|
Reference to the customer's payment method that will be used to collect subscription payments.\n\r\n> **Note:** This must be a valid payment option ID already created in the system for the customer.\n\r\n> **Tip:** Create a payment option for the customer before creating a subscription if the customer doesn't already have one. |
30 |
planId |
Reference |
|
|
|
|
Reference to the payment plan the customer is subscribing to.\n\r\n> **Note:** This must be a valid payment plan ID already created in the system.\n\r\n> **Tip:** The referenced plan determines the billing amount and available billing cycle options. |
32 |
type |
|
|
|
|
|
Type of subscription being created - either fixed-term or perpetual (ongoing). If this value is set to F (Fixed), you must specify the duration using the length field. For ongoing subscriptions, use P (Perpetual).\n\r\n> **Tip:** Choose F (Fixed) for services with a defined end date and P (Perpetual) for ongoing services. |
33 |
billingCycleType |
|
|
|
|
|
Frequency at which the customer will be billed for this subscription.\n\r\n> **Note:** Default: `M` (Monthly). Other options include A (Annual), S (Semi-annual), Q (Quarterly), and W (Weekly).\n\r\n> **Tip:** This typically should match the billing cycle type defined in the referenced plan. |
34 |
pendingAdjustmentEffectiveDate |
Date |
|
|
|
|
Date when the scheduled change will take effect. This field is required when pendingAdjustmentType is provided.\n\r\n> **Note:** Format must be yyyy-MM-dd. |
35 |
pendingAdjustmentNote |
String(255) |
|
|
|
|
Additional information about the scheduled adjustment. This field is required if any of the pendingAdjustment fields are provided.\n\r\n> **Note:** Maximum length is 255 characters. |
37 |
code |
String(60) |
|
|
|
|
Optional secondary identifier for the subscription that references an ID in your own system.\n\r\n> **Note:** If not provided, this value will default to the subscription's system-generated ID returned in the response.\n\r\n> **Tip:** Use this field to facilitate cross-referencing between systems and simplify reconciliation processes. |
39 |
nextInvoicingDate |
Date |
|
|
|
|
Date when the next invoice will be generated for this subscription.\n\r\n> **Note:** This field is typically calculated by the system rather than provided in the request. |
40 |
firstInvoicingDate |
Date |
|
|
|
|
Date when the first invoice will be generated for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This may differ from firstBillingDate if you want to generate invoices before collecting payment. |
41 |
taxAmount |
Integer |
|
|
|
|
Tax amount (in cents) to be applied to each billing cycle.\n\r\n> **Note:** This is typically derived from the referenced plan and does not need to be explicitly provided. |
42 |
planName |
String |
|
|
|
|
Name of the payment plan associated with this subscription.\n\r\n> **Note:** This field is typically derived from the planId and does not need to be explicitly provided in the request. |
~modify (response)
Method: POST
Implicit: Yes
Consumes: json,xml
Produces: json,xml
Updates the subscription with the specified values of the ''note'' and ''paymentOptionId'' fields.
# |
Name |
Type |
Pattern |
Format |
Mode |
Usage |
Description |
1 |
pendingAdjustmentType
|
|
|
|
|
|
Type of scheduled change to be applied to this subscription.\n\r\n> **Note:** This field is only included if a future adjustment has been scheduled.\n\r\n> **Tip:** Common values include F (Freeze), C (Cancel), or P (Pause). |
2 |
firstInvoicingDate
|
Date |
|
|
|
|
Date when the first invoice will be generated for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if invoicing is configured separately from billing. |
3 |
nextInvoicingDate
|
Date |
|
|
|
|
Date when the next invoice will be generated for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if relevant to the subscription's current state. |
4 |
taxAmount
|
Integer |
|
|
|
|
Tax amount (in cents) that will be applied to each billing cycle.\n\r\n> **Note:** This field is only included if tax calculation is enabled for this subscription. |
5 |
planName
|
String(255) |
|
|
|
|
Name of the payment plan associated with this subscription.\n\r\n> **Note:** This value is derived from the referenced planId and provides a human-readable identifier. |
6 |
billingCycleType
|
|
|
|
|
|
Frequency at which the customer will be billed for this subscription.\n\r\n> **Note:** Common values include M (Monthly), A (Annual), Q (Quarterly), etc. |
7 |
code
|
String(60) |
|
|
|
|
Secondary identifier for the subscription that references an ID in your own system.\n\r\n> **Note:** If you didn't provide a value in the request, this will be set to the same value as the id field.\n\r\n> **Tip:** Use this field to cross-reference subscriptions between systems. |
8 |
createDate
|
Datetime |
|
|
|
|
Date and time when the subscription was created in the system.\n\r\n> **Note:** This value is returned in yyyy-MM-dd HH:mm:ss format. |
9 |
firstBillingDate
|
Date |
|
|
|
|
Date when the first billing for this subscription will occur.\n\r\n> **Note:** Format must be yyyy-MM-dd. This date establishes the billing cycle start date. |
10 |
id
|
Long |
|
|
|
|
System-generated unique identifier for the newly created subscription.\n\r\n> **Note:** Use this identifier in subsequent API calls when referencing this subscription.\n\r\n> **Tip:** Store this value in your system for future subscription management operations. |
11 |
lastBillingDate
|
Date |
|
|
|
|
Final date when billing will occur for this subscription.\n\r\n> **Note:** This field is only included for subscriptions with type=F (Fixed). Format must be yyyy-MM-dd. |
12 |
lastUpdateDate
|
Datetime |
|
|
|
|
Date and time when the subscription was last modified.\n\r\n> **Note:** This value is returned in yyyy-MM-dd HH:mm:ss format. Matches createDate for newly created subscriptions. |
13 |
pendingAdjustmentEffectiveDate
|
Date |
|
|
|
|
Date when the scheduled change will take effect.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if pendingAdjustmentType is present. |
14 |
pendingAdjustmentLength
|
Integer |
|
|
|
|
Number of billing cycles for which the adjustment will apply.\n\r\n> **Note:** This field is only included if pendingAdjustmentType is F (Freeze). |
15 |
pendingAdjustmentNote
|
String(255) |
|
|
|
|
Additional information about the scheduled adjustment.\n\r\n> **Note:** This field is only included if pendingAdjustmentType is present. |
16 |
planId
|
Reference |
|
|
|
|
Reference to the payment plan this subscription is based on.\n\r\n> **Note:** The plan defines the base pricing and billing terms for this subscription. |
17 |
status
|
|
|
|
|
|
Current status of the subscription in the system.\n\r\n> **Note:** For new subscriptions, this is typically set to "Current" or "Unbilled" depending on the billing schedule. |
18 |
id
|
Long |
|
|
|
|
System-generated unique identifier for the newly created subscription.\n\r\n> **Note:** Use this identifier in subsequent API calls when referencing this subscription.\n\r\n> **Tip:** Store this value in your system for future subscription management operations. |
19 |
accountId
|
Integer |
|
|
|
|
Identifier of the merchant account under which this subscription was created.\n\r\n> **Note:** This indicates which merchant account is managing this subscription. |
20 |
amount
|
Integer |
|
|
|
|
Amount (in cents) that will be charged for each billing cycle of this subscription.\n\r\n> **Note:** For example, $10.00 would be represented as 1000. |
21 |
createDate
|
Datetime |
|
|
|
|
Date and time when the subscription was created in the system.\n\r\n> **Note:** This value is returned in yyyy-MM-dd HH:mm:ss format. |
22 |
customerId
|
Long |
|
|
|
|
Identifier of the customer for whom the subscription is being created.\n\r\n> **Tip:** Use this to retrieve customer details or to group all subscriptions for a particular customer. |
23 |
firstBillingDate
|
Date |
|
|
|
|
Date when the first billing for this subscription will occur.\n\r\n> **Note:** Format must be yyyy-MM-dd. This date establishes the billing cycle start date. |
24 |
lastBillingDate
|
Date |
|
|
|
|
Final date when billing will occur for this subscription.\n\r\n> **Note:** This field is only included for subscriptions with type=F (Fixed). Format must be yyyy-MM-dd. |
25 |
lastUpdateDate
|
Datetime |
|
|
|
|
Date and time when the subscription was last modified.\n\r\n> **Note:** This value is returned in yyyy-MM-dd HH:mm:ss format. Matches createDate for newly created subscriptions. |
26 |
length
|
Integer |
|
|
|
|
Number of billing cycles for which the subscription will be active.\n\r\n> **Note:** This field is only included for subscriptions with type=F (Fixed). The maximum value depends on the billingCycleType: A (Annual) - 3, S (Semi-annual) - 6, Q (Quarterly) - 12, M (Monthly) - 36, W (Weekly) - 153. |
27 |
nextBillingDate
|
Date |
|
|
|
|
Date when the next billing will occur for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This value is automatically calculated based on the billing cycle and the firstBillingDate. |
28 |
note
|
String(255) |
|
|
|
|
Additional information or comments about this subscription.\n\r\n> **Note:** This field is only included if a note was provided in the request. |
29 |
paymentOptionId
|
Reference |
|
|
|
|
Reference to the customer's payment method that will be used to collect subscription payments.\n\r\n> **Note:** This is the payment method that will be charged according to the subscription schedule. |
30 |
planId
|
Reference |
|
|
|
|
Reference to the payment plan this subscription is based on.\n\r\n> **Note:** The plan defines the base pricing and billing terms for this subscription. |
31 |
status
|
|
|
|
|
|
Current status of the subscription in the system.\n\r\n> **Note:** For new subscriptions, this is typically set to "Current" or "Unbilled" depending on the billing schedule. |
32 |
type
|
|
|
|
|
|
Type of subscription - either fixed-term or perpetual (ongoing).\n\r\n> **Note:** F (Fixed) indicates a subscription with a defined end date, while P (Perpetual) indicates an ongoing subscription. |
33 |
billingCycleType
|
|
|
|
|
|
Frequency at which the customer will be billed for this subscription.\n\r\n> **Note:** Common values include M (Monthly), A (Annual), Q (Quarterly), etc. |
34 |
pendingAdjustmentEffectiveDate
|
Date |
|
|
|
|
Date when the scheduled change will take effect.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if pendingAdjustmentType is present. |
35 |
pendingAdjustmentNote
|
String(255) |
|
|
|
|
Additional information about the scheduled adjustment.\n\r\n> **Note:** This field is only included if pendingAdjustmentType is present. |
36 |
pendingAdjustmentLength
|
Integer |
|
|
|
|
Number of billing cycles for which the adjustment will apply.\n\r\n> **Note:** This field is only included if pendingAdjustmentType is F (Freeze). |
37 |
code
|
String(60) |
|
|
|
|
Secondary identifier for the subscription that references an ID in your own system.\n\r\n> **Note:** If you didn't provide a value in the request, this will be set to the same value as the id field.\n\r\n> **Tip:** Use this field to cross-reference subscriptions between systems. |
38 |
planName
|
String |
|
|
|
|
Name of the payment plan associated with this subscription.\n\r\n> **Note:** This value is derived from the referenced planId and provides a human-readable identifier. |
39 |
nextInvoicingDate
|
Date |
|
|
|
|
Date when the next invoice will be generated for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if relevant to the subscription's current state. |
40 |
firstInvoicingDate
|
Date |
|
|
|
|
Date when the first invoice will be generated for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if invoicing is configured separately from billing. |
41 |
taxAmount
|
Integer |
|
|
|
|
Tax amount (in cents) that will be applied to each billing cycle.\n\r\n> **Note:** This field is only included if tax calculation is enabled for this subscription. |
42 |
planName
|
String |
|
|
|
|
Name of the payment plan associated with this subscription.\n\r\n> **Note:** This value is derived from the referenced planId and provides a human-readable identifier. |
~pause (request)
Consumes: xurl
Produces: json,xml,xurl
Pauses the subscription right away or on the specified date.
# |
Name |
Type |
Pattern |
Format |
Mode |
Usage |
Description |
1 |
customer-id |
Long |
|
|
|
|
System-generated unique identifier for the customer.\n\r\n> **Note:** Automatically generated by the system. This field must not be provided in your request. |
2 |
subscription-id |
Long |
|
|
|
|
Unique Subscription ID generated by the system. |
# |
Name |
Type |
Pattern |
Format |
Mode |
Usage |
Description |
1 |
effectiveDate |
Date |
|
|
|
|
Date when the subscription is going to be put on pause. |
2 |
note |
String |
|
|
|
|
Any notes related to the pausing of the subscription. |
~pause (response)
Consumes: xurl
Produces: json,xml,xurl
Pauses the subscription right away or on the specified date.
# |
Name |
Type |
Pattern |
Format |
Mode |
Usage |
Description |
1 |
pendingAdjustmentType
|
|
|
|
|
|
Type of scheduled change to be applied to this subscription.\n\r\n> **Note:** This field is only included if a future adjustment has been scheduled.\n\r\n> **Tip:** Common values include F (Freeze), C (Cancel), or P (Pause). |
2 |
firstInvoicingDate
|
Date |
|
|
|
|
Date when the first invoice will be generated for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if invoicing is configured separately from billing. |
3 |
nextInvoicingDate
|
Date |
|
|
|
|
Date when the next invoice will be generated for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if relevant to the subscription's current state. |
4 |
taxAmount
|
Integer |
|
|
|
|
Tax amount (in cents) that will be applied to each billing cycle.\n\r\n> **Note:** This field is only included if tax calculation is enabled for this subscription. |
5 |
planName
|
String(255) |
|
|
|
|
Name of the payment plan associated with this subscription.\n\r\n> **Note:** This value is derived from the referenced planId and provides a human-readable identifier. |
6 |
billingCycleType
|
|
|
|
|
|
Frequency at which the customer will be billed for this subscription.\n\r\n> **Note:** Common values include M (Monthly), A (Annual), Q (Quarterly), etc. |
7 |
code
|
String(60) |
|
|
|
|
Secondary identifier for the subscription that references an ID in your own system.\n\r\n> **Note:** If you didn't provide a value in the request, this will be set to the same value as the id field.\n\r\n> **Tip:** Use this field to cross-reference subscriptions between systems. |
8 |
createDate
|
Datetime |
|
|
|
|
Date and time when the subscription was created in the system.\n\r\n> **Note:** This value is returned in yyyy-MM-dd HH:mm:ss format. |
9 |
firstBillingDate
|
Date |
|
|
|
|
Date when the first billing for this subscription will occur.\n\r\n> **Note:** Format must be yyyy-MM-dd. This date establishes the billing cycle start date. |
10 |
id
|
Long |
|
|
|
|
System-generated unique identifier for the newly created subscription.\n\r\n> **Note:** Use this identifier in subsequent API calls when referencing this subscription.\n\r\n> **Tip:** Store this value in your system for future subscription management operations. |
11 |
lastBillingDate
|
Date |
|
|
|
|
Final date when billing will occur for this subscription.\n\r\n> **Note:** This field is only included for subscriptions with type=F (Fixed). Format must be yyyy-MM-dd. |
12 |
lastUpdateDate
|
Datetime |
|
|
|
|
Date and time when the subscription was last modified.\n\r\n> **Note:** This value is returned in yyyy-MM-dd HH:mm:ss format. Matches createDate for newly created subscriptions. |
13 |
pendingAdjustmentEffectiveDate
|
Date |
|
|
|
|
Date when the scheduled change will take effect.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if pendingAdjustmentType is present. |
14 |
pendingAdjustmentLength
|
Integer |
|
|
|
|
Number of billing cycles for which the adjustment will apply.\n\r\n> **Note:** This field is only included if pendingAdjustmentType is F (Freeze). |
15 |
pendingAdjustmentNote
|
String(255) |
|
|
|
|
Additional information about the scheduled adjustment.\n\r\n> **Note:** This field is only included if pendingAdjustmentType is present. |
16 |
planId
|
Reference |
|
|
|
|
Reference to the payment plan this subscription is based on.\n\r\n> **Note:** The plan defines the base pricing and billing terms for this subscription. |
17 |
status
|
|
|
|
|
|
Current status of the subscription in the system.\n\r\n> **Note:** For new subscriptions, this is typically set to "Current" or "Unbilled" depending on the billing schedule. |
18 |
id
|
Long |
|
|
|
|
System-generated unique identifier for the newly created subscription.\n\r\n> **Note:** Use this identifier in subsequent API calls when referencing this subscription.\n\r\n> **Tip:** Store this value in your system for future subscription management operations. |
19 |
accountId
|
Integer |
|
|
|
|
Identifier of the merchant account under which this subscription was created.\n\r\n> **Note:** This indicates which merchant account is managing this subscription. |
20 |
amount
|
Integer |
|
|
|
|
Amount (in cents) that will be charged for each billing cycle of this subscription.\n\r\n> **Note:** For example, $10.00 would be represented as 1000. |
21 |
createDate
|
Datetime |
|
|
|
|
Date and time when the subscription was created in the system.\n\r\n> **Note:** This value is returned in yyyy-MM-dd HH:mm:ss format. |
22 |
customerId
|
Long |
|
|
|
|
Identifier of the customer for whom the subscription is being created.\n\r\n> **Tip:** Use this to retrieve customer details or to group all subscriptions for a particular customer. |
23 |
firstBillingDate
|
Date |
|
|
|
|
Date when the first billing for this subscription will occur.\n\r\n> **Note:** Format must be yyyy-MM-dd. This date establishes the billing cycle start date. |
24 |
lastBillingDate
|
Date |
|
|
|
|
Final date when billing will occur for this subscription.\n\r\n> **Note:** This field is only included for subscriptions with type=F (Fixed). Format must be yyyy-MM-dd. |
25 |
lastUpdateDate
|
Datetime |
|
|
|
|
Date and time when the subscription was last modified.\n\r\n> **Note:** This value is returned in yyyy-MM-dd HH:mm:ss format. Matches createDate for newly created subscriptions. |
26 |
length
|
Integer |
|
|
|
|
Number of billing cycles for which the subscription will be active.\n\r\n> **Note:** This field is only included for subscriptions with type=F (Fixed). The maximum value depends on the billingCycleType: A (Annual) - 3, S (Semi-annual) - 6, Q (Quarterly) - 12, M (Monthly) - 36, W (Weekly) - 153. |
27 |
nextBillingDate
|
Date |
|
|
|
|
Date when the next billing will occur for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This value is automatically calculated based on the billing cycle and the firstBillingDate. |
28 |
note
|
String(255) |
|
|
|
|
Additional information or comments about this subscription.\n\r\n> **Note:** This field is only included if a note was provided in the request. |
29 |
paymentOptionId
|
Reference |
|
|
|
|
Reference to the customer's payment method that will be used to collect subscription payments.\n\r\n> **Note:** This is the payment method that will be charged according to the subscription schedule. |
30 |
planId
|
Reference |
|
|
|
|
Reference to the payment plan this subscription is based on.\n\r\n> **Note:** The plan defines the base pricing and billing terms for this subscription. |
31 |
status
|
|
|
|
|
|
Current status of the subscription in the system.\n\r\n> **Note:** For new subscriptions, this is typically set to "Current" or "Unbilled" depending on the billing schedule. |
32 |
type
|
|
|
|
|
|
Type of subscription - either fixed-term or perpetual (ongoing).\n\r\n> **Note:** F (Fixed) indicates a subscription with a defined end date, while P (Perpetual) indicates an ongoing subscription. |
33 |
billingCycleType
|
|
|
|
|
|
Frequency at which the customer will be billed for this subscription.\n\r\n> **Note:** Common values include M (Monthly), A (Annual), Q (Quarterly), etc. |
34 |
pendingAdjustmentEffectiveDate
|
Date |
|
|
|
|
Date when the scheduled change will take effect.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if pendingAdjustmentType is present. |
35 |
pendingAdjustmentNote
|
String(255) |
|
|
|
|
Additional information about the scheduled adjustment.\n\r\n> **Note:** This field is only included if pendingAdjustmentType is present. |
36 |
pendingAdjustmentLength
|
Integer |
|
|
|
|
Number of billing cycles for which the adjustment will apply.\n\r\n> **Note:** This field is only included if pendingAdjustmentType is F (Freeze). |
37 |
code
|
String(60) |
|
|
|
|
Secondary identifier for the subscription that references an ID in your own system.\n\r\n> **Note:** If you didn't provide a value in the request, this will be set to the same value as the id field.\n\r\n> **Tip:** Use this field to cross-reference subscriptions between systems. |
38 |
planName
|
String |
|
|
|
|
Name of the payment plan associated with this subscription.\n\r\n> **Note:** This value is derived from the referenced planId and provides a human-readable identifier. |
39 |
nextInvoicingDate
|
Date |
|
|
|
|
Date when the next invoice will be generated for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if relevant to the subscription's current state. |
40 |
firstInvoicingDate
|
Date |
|
|
|
|
Date when the first invoice will be generated for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if invoicing is configured separately from billing. |
41 |
taxAmount
|
Integer |
|
|
|
|
Tax amount (in cents) that will be applied to each billing cycle.\n\r\n> **Note:** This field is only included if tax calculation is enabled for this subscription. |
42 |
planName
|
String |
|
|
|
|
Name of the payment plan associated with this subscription.\n\r\n> **Note:** This value is derived from the referenced planId and provides a human-readable identifier. |
~uncancel (request)
Consumes: xurl
Produces: json,xml,xurl
Uncancels the specified subscription.
Can be applied only to the subscriptions that have not been canceled yet.
# |
Name |
Type |
Pattern |
Format |
Mode |
Usage |
Description |
1 |
customer-id |
Long |
|
|
|
|
System-generated unique identifier for the customer.\n\r\n> **Note:** Automatically generated by the system. This field must not be provided in your request. |
2 |
subscription-id |
Long |
|
|
|
|
Unique Subscription ID generated by the system. |
~uncancel (response)
Consumes: xurl
Produces: json,xml,xurl
Uncancels the specified subscription.
Can be applied only to the subscriptions that have not been canceled yet.
# |
Name |
Type |
Pattern |
Format |
Mode |
Usage |
Description |
1 |
pendingAdjustmentType
|
|
|
|
|
|
Type of scheduled change to be applied to this subscription.\n\r\n> **Note:** This field is only included if a future adjustment has been scheduled.\n\r\n> **Tip:** Common values include F (Freeze), C (Cancel), or P (Pause). |
2 |
firstInvoicingDate
|
Date |
|
|
|
|
Date when the first invoice will be generated for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if invoicing is configured separately from billing. |
3 |
nextInvoicingDate
|
Date |
|
|
|
|
Date when the next invoice will be generated for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if relevant to the subscription's current state. |
4 |
taxAmount
|
Integer |
|
|
|
|
Tax amount (in cents) that will be applied to each billing cycle.\n\r\n> **Note:** This field is only included if tax calculation is enabled for this subscription. |
5 |
planName
|
String(255) |
|
|
|
|
Name of the payment plan associated with this subscription.\n\r\n> **Note:** This value is derived from the referenced planId and provides a human-readable identifier. |
6 |
billingCycleType
|
|
|
|
|
|
Frequency at which the customer will be billed for this subscription.\n\r\n> **Note:** Common values include M (Monthly), A (Annual), Q (Quarterly), etc. |
7 |
code
|
String(60) |
|
|
|
|
Secondary identifier for the subscription that references an ID in your own system.\n\r\n> **Note:** If you didn't provide a value in the request, this will be set to the same value as the id field.\n\r\n> **Tip:** Use this field to cross-reference subscriptions between systems. |
8 |
createDate
|
Datetime |
|
|
|
|
Date and time when the subscription was created in the system.\n\r\n> **Note:** This value is returned in yyyy-MM-dd HH:mm:ss format. |
9 |
firstBillingDate
|
Date |
|
|
|
|
Date when the first billing for this subscription will occur.\n\r\n> **Note:** Format must be yyyy-MM-dd. This date establishes the billing cycle start date. |
10 |
id
|
Long |
|
|
|
|
System-generated unique identifier for the newly created subscription.\n\r\n> **Note:** Use this identifier in subsequent API calls when referencing this subscription.\n\r\n> **Tip:** Store this value in your system for future subscription management operations. |
11 |
lastBillingDate
|
Date |
|
|
|
|
Final date when billing will occur for this subscription.\n\r\n> **Note:** This field is only included for subscriptions with type=F (Fixed). Format must be yyyy-MM-dd. |
12 |
lastUpdateDate
|
Datetime |
|
|
|
|
Date and time when the subscription was last modified.\n\r\n> **Note:** This value is returned in yyyy-MM-dd HH:mm:ss format. Matches createDate for newly created subscriptions. |
13 |
pendingAdjustmentEffectiveDate
|
Date |
|
|
|
|
Date when the scheduled change will take effect.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if pendingAdjustmentType is present. |
14 |
pendingAdjustmentLength
|
Integer |
|
|
|
|
Number of billing cycles for which the adjustment will apply.\n\r\n> **Note:** This field is only included if pendingAdjustmentType is F (Freeze). |
15 |
pendingAdjustmentNote
|
String(255) |
|
|
|
|
Additional information about the scheduled adjustment.\n\r\n> **Note:** This field is only included if pendingAdjustmentType is present. |
16 |
planId
|
Reference |
|
|
|
|
Reference to the payment plan this subscription is based on.\n\r\n> **Note:** The plan defines the base pricing and billing terms for this subscription. |
17 |
status
|
|
|
|
|
|
Current status of the subscription in the system.\n\r\n> **Note:** For new subscriptions, this is typically set to "Current" or "Unbilled" depending on the billing schedule. |
18 |
id
|
Long |
|
|
|
|
System-generated unique identifier for the newly created subscription.\n\r\n> **Note:** Use this identifier in subsequent API calls when referencing this subscription.\n\r\n> **Tip:** Store this value in your system for future subscription management operations. |
19 |
accountId
|
Integer |
|
|
|
|
Identifier of the merchant account under which this subscription was created.\n\r\n> **Note:** This indicates which merchant account is managing this subscription. |
20 |
amount
|
Integer |
|
|
|
|
Amount (in cents) that will be charged for each billing cycle of this subscription.\n\r\n> **Note:** For example, $10.00 would be represented as 1000. |
21 |
createDate
|
Datetime |
|
|
|
|
Date and time when the subscription was created in the system.\n\r\n> **Note:** This value is returned in yyyy-MM-dd HH:mm:ss format. |
22 |
customerId
|
Long |
|
|
|
|
Identifier of the customer for whom the subscription is being created.\n\r\n> **Tip:** Use this to retrieve customer details or to group all subscriptions for a particular customer. |
23 |
firstBillingDate
|
Date |
|
|
|
|
Date when the first billing for this subscription will occur.\n\r\n> **Note:** Format must be yyyy-MM-dd. This date establishes the billing cycle start date. |
24 |
lastBillingDate
|
Date |
|
|
|
|
Final date when billing will occur for this subscription.\n\r\n> **Note:** This field is only included for subscriptions with type=F (Fixed). Format must be yyyy-MM-dd. |
25 |
lastUpdateDate
|
Datetime |
|
|
|
|
Date and time when the subscription was last modified.\n\r\n> **Note:** This value is returned in yyyy-MM-dd HH:mm:ss format. Matches createDate for newly created subscriptions. |
26 |
length
|
Integer |
|
|
|
|
Number of billing cycles for which the subscription will be active.\n\r\n> **Note:** This field is only included for subscriptions with type=F (Fixed). The maximum value depends on the billingCycleType: A (Annual) - 3, S (Semi-annual) - 6, Q (Quarterly) - 12, M (Monthly) - 36, W (Weekly) - 153. |
27 |
nextBillingDate
|
Date |
|
|
|
|
Date when the next billing will occur for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This value is automatically calculated based on the billing cycle and the firstBillingDate. |
28 |
note
|
String(255) |
|
|
|
|
Additional information or comments about this subscription.\n\r\n> **Note:** This field is only included if a note was provided in the request. |
29 |
paymentOptionId
|
Reference |
|
|
|
|
Reference to the customer's payment method that will be used to collect subscription payments.\n\r\n> **Note:** This is the payment method that will be charged according to the subscription schedule. |
30 |
planId
|
Reference |
|
|
|
|
Reference to the payment plan this subscription is based on.\n\r\n> **Note:** The plan defines the base pricing and billing terms for this subscription. |
31 |
status
|
|
|
|
|
|
Current status of the subscription in the system.\n\r\n> **Note:** For new subscriptions, this is typically set to "Current" or "Unbilled" depending on the billing schedule. |
32 |
type
|
|
|
|
|
|
Type of subscription - either fixed-term or perpetual (ongoing).\n\r\n> **Note:** F (Fixed) indicates a subscription with a defined end date, while P (Perpetual) indicates an ongoing subscription. |
33 |
billingCycleType
|
|
|
|
|
|
Frequency at which the customer will be billed for this subscription.\n\r\n> **Note:** Common values include M (Monthly), A (Annual), Q (Quarterly), etc. |
34 |
pendingAdjustmentEffectiveDate
|
Date |
|
|
|
|
Date when the scheduled change will take effect.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if pendingAdjustmentType is present. |
35 |
pendingAdjustmentNote
|
String(255) |
|
|
|
|
Additional information about the scheduled adjustment.\n\r\n> **Note:** This field is only included if pendingAdjustmentType is present. |
36 |
pendingAdjustmentLength
|
Integer |
|
|
|
|
Number of billing cycles for which the adjustment will apply.\n\r\n> **Note:** This field is only included if pendingAdjustmentType is F (Freeze). |
37 |
code
|
String(60) |
|
|
|
|
Secondary identifier for the subscription that references an ID in your own system.\n\r\n> **Note:** If you didn't provide a value in the request, this will be set to the same value as the id field.\n\r\n> **Tip:** Use this field to cross-reference subscriptions between systems. |
38 |
planName
|
String |
|
|
|
|
Name of the payment plan associated with this subscription.\n\r\n> **Note:** This value is derived from the referenced planId and provides a human-readable identifier. |
39 |
nextInvoicingDate
|
Date |
|
|
|
|
Date when the next invoice will be generated for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if relevant to the subscription's current state. |
40 |
firstInvoicingDate
|
Date |
|
|
|
|
Date when the first invoice will be generated for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if invoicing is configured separately from billing. |
41 |
taxAmount
|
Integer |
|
|
|
|
Tax amount (in cents) that will be applied to each billing cycle.\n\r\n> **Note:** This field is only included if tax calculation is enabled for this subscription. |
42 |
planName
|
String |
|
|
|
|
Name of the payment plan associated with this subscription.\n\r\n> **Note:** This value is derived from the referenced planId and provides a human-readable identifier. |
~unfreeze (request)
Consumes: xurl
Produces: json,xml,xurl
Unfreezes the specified subscription.
Can be applied only to the subscriptions that have been previously frozen.
# |
Name |
Type |
Pattern |
Format |
Mode |
Usage |
Description |
1 |
customer-id |
Long |
|
|
|
|
System-generated unique identifier for the customer.\n\r\n> **Note:** Automatically generated by the system. This field must not be provided in your request. |
2 |
subscription-id |
Long |
|
|
|
|
Unique Subscription ID generated by the system. |
~unfreeze (response)
Consumes: xurl
Produces: json,xml,xurl
Unfreezes the specified subscription.
Can be applied only to the subscriptions that have been previously frozen.
# |
Name |
Type |
Pattern |
Format |
Mode |
Usage |
Description |
1 |
pendingAdjustmentType
|
|
|
|
|
|
Type of scheduled change to be applied to this subscription.\n\r\n> **Note:** This field is only included if a future adjustment has been scheduled.\n\r\n> **Tip:** Common values include F (Freeze), C (Cancel), or P (Pause). |
2 |
firstInvoicingDate
|
Date |
|
|
|
|
Date when the first invoice will be generated for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if invoicing is configured separately from billing. |
3 |
nextInvoicingDate
|
Date |
|
|
|
|
Date when the next invoice will be generated for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if relevant to the subscription's current state. |
4 |
taxAmount
|
Integer |
|
|
|
|
Tax amount (in cents) that will be applied to each billing cycle.\n\r\n> **Note:** This field is only included if tax calculation is enabled for this subscription. |
5 |
planName
|
String(255) |
|
|
|
|
Name of the payment plan associated with this subscription.\n\r\n> **Note:** This value is derived from the referenced planId and provides a human-readable identifier. |
6 |
billingCycleType
|
|
|
|
|
|
Frequency at which the customer will be billed for this subscription.\n\r\n> **Note:** Common values include M (Monthly), A (Annual), Q (Quarterly), etc. |
7 |
code
|
String(60) |
|
|
|
|
Secondary identifier for the subscription that references an ID in your own system.\n\r\n> **Note:** If you didn't provide a value in the request, this will be set to the same value as the id field.\n\r\n> **Tip:** Use this field to cross-reference subscriptions between systems. |
8 |
createDate
|
Datetime |
|
|
|
|
Date and time when the subscription was created in the system.\n\r\n> **Note:** This value is returned in yyyy-MM-dd HH:mm:ss format. |
9 |
firstBillingDate
|
Date |
|
|
|
|
Date when the first billing for this subscription will occur.\n\r\n> **Note:** Format must be yyyy-MM-dd. This date establishes the billing cycle start date. |
10 |
id
|
Long |
|
|
|
|
System-generated unique identifier for the newly created subscription.\n\r\n> **Note:** Use this identifier in subsequent API calls when referencing this subscription.\n\r\n> **Tip:** Store this value in your system for future subscription management operations. |
11 |
lastBillingDate
|
Date |
|
|
|
|
Final date when billing will occur for this subscription.\n\r\n> **Note:** This field is only included for subscriptions with type=F (Fixed). Format must be yyyy-MM-dd. |
12 |
lastUpdateDate
|
Datetime |
|
|
|
|
Date and time when the subscription was last modified.\n\r\n> **Note:** This value is returned in yyyy-MM-dd HH:mm:ss format. Matches createDate for newly created subscriptions. |
13 |
pendingAdjustmentEffectiveDate
|
Date |
|
|
|
|
Date when the scheduled change will take effect.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if pendingAdjustmentType is present. |
14 |
pendingAdjustmentLength
|
Integer |
|
|
|
|
Number of billing cycles for which the adjustment will apply.\n\r\n> **Note:** This field is only included if pendingAdjustmentType is F (Freeze). |
15 |
pendingAdjustmentNote
|
String(255) |
|
|
|
|
Additional information about the scheduled adjustment.\n\r\n> **Note:** This field is only included if pendingAdjustmentType is present. |
16 |
planId
|
Reference |
|
|
|
|
Reference to the payment plan this subscription is based on.\n\r\n> **Note:** The plan defines the base pricing and billing terms for this subscription. |
17 |
status
|
|
|
|
|
|
Current status of the subscription in the system.\n\r\n> **Note:** For new subscriptions, this is typically set to "Current" or "Unbilled" depending on the billing schedule. |
18 |
id
|
Long |
|
|
|
|
System-generated unique identifier for the newly created subscription.\n\r\n> **Note:** Use this identifier in subsequent API calls when referencing this subscription.\n\r\n> **Tip:** Store this value in your system for future subscription management operations. |
19 |
accountId
|
Integer |
|
|
|
|
Identifier of the merchant account under which this subscription was created.\n\r\n> **Note:** This indicates which merchant account is managing this subscription. |
20 |
amount
|
Integer |
|
|
|
|
Amount (in cents) that will be charged for each billing cycle of this subscription.\n\r\n> **Note:** For example, $10.00 would be represented as 1000. |
21 |
createDate
|
Datetime |
|
|
|
|
Date and time when the subscription was created in the system.\n\r\n> **Note:** This value is returned in yyyy-MM-dd HH:mm:ss format. |
22 |
customerId
|
Long |
|
|
|
|
Identifier of the customer for whom the subscription is being created.\n\r\n> **Tip:** Use this to retrieve customer details or to group all subscriptions for a particular customer. |
23 |
firstBillingDate
|
Date |
|
|
|
|
Date when the first billing for this subscription will occur.\n\r\n> **Note:** Format must be yyyy-MM-dd. This date establishes the billing cycle start date. |
24 |
lastBillingDate
|
Date |
|
|
|
|
Final date when billing will occur for this subscription.\n\r\n> **Note:** This field is only included for subscriptions with type=F (Fixed). Format must be yyyy-MM-dd. |
25 |
lastUpdateDate
|
Datetime |
|
|
|
|
Date and time when the subscription was last modified.\n\r\n> **Note:** This value is returned in yyyy-MM-dd HH:mm:ss format. Matches createDate for newly created subscriptions. |
26 |
length
|
Integer |
|
|
|
|
Number of billing cycles for which the subscription will be active.\n\r\n> **Note:** This field is only included for subscriptions with type=F (Fixed). The maximum value depends on the billingCycleType: A (Annual) - 3, S (Semi-annual) - 6, Q (Quarterly) - 12, M (Monthly) - 36, W (Weekly) - 153. |
27 |
nextBillingDate
|
Date |
|
|
|
|
Date when the next billing will occur for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This value is automatically calculated based on the billing cycle and the firstBillingDate. |
28 |
note
|
String(255) |
|
|
|
|
Additional information or comments about this subscription.\n\r\n> **Note:** This field is only included if a note was provided in the request. |
29 |
paymentOptionId
|
Reference |
|
|
|
|
Reference to the customer's payment method that will be used to collect subscription payments.\n\r\n> **Note:** This is the payment method that will be charged according to the subscription schedule. |
30 |
planId
|
Reference |
|
|
|
|
Reference to the payment plan this subscription is based on.\n\r\n> **Note:** The plan defines the base pricing and billing terms for this subscription. |
31 |
status
|
|
|
|
|
|
Current status of the subscription in the system.\n\r\n> **Note:** For new subscriptions, this is typically set to "Current" or "Unbilled" depending on the billing schedule. |
32 |
type
|
|
|
|
|
|
Type of subscription - either fixed-term or perpetual (ongoing).\n\r\n> **Note:** F (Fixed) indicates a subscription with a defined end date, while P (Perpetual) indicates an ongoing subscription. |
33 |
billingCycleType
|
|
|
|
|
|
Frequency at which the customer will be billed for this subscription.\n\r\n> **Note:** Common values include M (Monthly), A (Annual), Q (Quarterly), etc. |
34 |
pendingAdjustmentEffectiveDate
|
Date |
|
|
|
|
Date when the scheduled change will take effect.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if pendingAdjustmentType is present. |
35 |
pendingAdjustmentNote
|
String(255) |
|
|
|
|
Additional information about the scheduled adjustment.\n\r\n> **Note:** This field is only included if pendingAdjustmentType is present. |
36 |
pendingAdjustmentLength
|
Integer |
|
|
|
|
Number of billing cycles for which the adjustment will apply.\n\r\n> **Note:** This field is only included if pendingAdjustmentType is F (Freeze). |
37 |
code
|
String(60) |
|
|
|
|
Secondary identifier for the subscription that references an ID in your own system.\n\r\n> **Note:** If you didn't provide a value in the request, this will be set to the same value as the id field.\n\r\n> **Tip:** Use this field to cross-reference subscriptions between systems. |
38 |
planName
|
String |
|
|
|
|
Name of the payment plan associated with this subscription.\n\r\n> **Note:** This value is derived from the referenced planId and provides a human-readable identifier. |
39 |
nextInvoicingDate
|
Date |
|
|
|
|
Date when the next invoice will be generated for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if relevant to the subscription's current state. |
40 |
firstInvoicingDate
|
Date |
|
|
|
|
Date when the first invoice will be generated for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if invoicing is configured separately from billing. |
41 |
taxAmount
|
Integer |
|
|
|
|
Tax amount (in cents) that will be applied to each billing cycle.\n\r\n> **Note:** This field is only included if tax calculation is enabled for this subscription. |
42 |
planName
|
String |
|
|
|
|
Name of the payment plan associated with this subscription.\n\r\n> **Note:** This value is derived from the referenced planId and provides a human-readable identifier. |
~unpause (request)
Consumes: xurl
Produces: json,xml,xurl
Unpauses the specified subscription.
Can be applied only to the subscriptions that have been previously paused.
# |
Name |
Type |
Pattern |
Format |
Mode |
Usage |
Description |
1 |
customer-id |
Long |
|
|
|
|
System-generated unique identifier for the customer.\n\r\n> **Note:** Automatically generated by the system. This field must not be provided in your request. |
2 |
subscription-id |
Long |
|
|
|
|
Unique Subscription ID generated by the system. |
~unpause (response)
Consumes: xurl
Produces: json,xml,xurl
Unpauses the specified subscription.
Can be applied only to the subscriptions that have been previously paused.
# |
Name |
Type |
Pattern |
Format |
Mode |
Usage |
Description |
1 |
pendingAdjustmentType
|
|
|
|
|
|
Type of scheduled change to be applied to this subscription.\n\r\n> **Note:** This field is only included if a future adjustment has been scheduled.\n\r\n> **Tip:** Common values include F (Freeze), C (Cancel), or P (Pause). |
2 |
firstInvoicingDate
|
Date |
|
|
|
|
Date when the first invoice will be generated for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if invoicing is configured separately from billing. |
3 |
nextInvoicingDate
|
Date |
|
|
|
|
Date when the next invoice will be generated for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if relevant to the subscription's current state. |
4 |
taxAmount
|
Integer |
|
|
|
|
Tax amount (in cents) that will be applied to each billing cycle.\n\r\n> **Note:** This field is only included if tax calculation is enabled for this subscription. |
5 |
planName
|
String(255) |
|
|
|
|
Name of the payment plan associated with this subscription.\n\r\n> **Note:** This value is derived from the referenced planId and provides a human-readable identifier. |
6 |
billingCycleType
|
|
|
|
|
|
Frequency at which the customer will be billed for this subscription.\n\r\n> **Note:** Common values include M (Monthly), A (Annual), Q (Quarterly), etc. |
7 |
code
|
String(60) |
|
|
|
|
Secondary identifier for the subscription that references an ID in your own system.\n\r\n> **Note:** If you didn't provide a value in the request, this will be set to the same value as the id field.\n\r\n> **Tip:** Use this field to cross-reference subscriptions between systems. |
8 |
createDate
|
Datetime |
|
|
|
|
Date and time when the subscription was created in the system.\n\r\n> **Note:** This value is returned in yyyy-MM-dd HH:mm:ss format. |
9 |
firstBillingDate
|
Date |
|
|
|
|
Date when the first billing for this subscription will occur.\n\r\n> **Note:** Format must be yyyy-MM-dd. This date establishes the billing cycle start date. |
10 |
id
|
Long |
|
|
|
|
System-generated unique identifier for the newly created subscription.\n\r\n> **Note:** Use this identifier in subsequent API calls when referencing this subscription.\n\r\n> **Tip:** Store this value in your system for future subscription management operations. |
11 |
lastBillingDate
|
Date |
|
|
|
|
Final date when billing will occur for this subscription.\n\r\n> **Note:** This field is only included for subscriptions with type=F (Fixed). Format must be yyyy-MM-dd. |
12 |
lastUpdateDate
|
Datetime |
|
|
|
|
Date and time when the subscription was last modified.\n\r\n> **Note:** This value is returned in yyyy-MM-dd HH:mm:ss format. Matches createDate for newly created subscriptions. |
13 |
pendingAdjustmentEffectiveDate
|
Date |
|
|
|
|
Date when the scheduled change will take effect.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if pendingAdjustmentType is present. |
14 |
pendingAdjustmentLength
|
Integer |
|
|
|
|
Number of billing cycles for which the adjustment will apply.\n\r\n> **Note:** This field is only included if pendingAdjustmentType is F (Freeze). |
15 |
pendingAdjustmentNote
|
String(255) |
|
|
|
|
Additional information about the scheduled adjustment.\n\r\n> **Note:** This field is only included if pendingAdjustmentType is present. |
16 |
planId
|
Reference |
|
|
|
|
Reference to the payment plan this subscription is based on.\n\r\n> **Note:** The plan defines the base pricing and billing terms for this subscription. |
17 |
status
|
|
|
|
|
|
Current status of the subscription in the system.\n\r\n> **Note:** For new subscriptions, this is typically set to "Current" or "Unbilled" depending on the billing schedule. |
18 |
id
|
Long |
|
|
|
|
System-generated unique identifier for the newly created subscription.\n\r\n> **Note:** Use this identifier in subsequent API calls when referencing this subscription.\n\r\n> **Tip:** Store this value in your system for future subscription management operations. |
19 |
accountId
|
Integer |
|
|
|
|
Identifier of the merchant account under which this subscription was created.\n\r\n> **Note:** This indicates which merchant account is managing this subscription. |
20 |
amount
|
Integer |
|
|
|
|
Amount (in cents) that will be charged for each billing cycle of this subscription.\n\r\n> **Note:** For example, $10.00 would be represented as 1000. |
21 |
createDate
|
Datetime |
|
|
|
|
Date and time when the subscription was created in the system.\n\r\n> **Note:** This value is returned in yyyy-MM-dd HH:mm:ss format. |
22 |
customerId
|
Long |
|
|
|
|
Identifier of the customer for whom the subscription is being created.\n\r\n> **Tip:** Use this to retrieve customer details or to group all subscriptions for a particular customer. |
23 |
firstBillingDate
|
Date |
|
|
|
|
Date when the first billing for this subscription will occur.\n\r\n> **Note:** Format must be yyyy-MM-dd. This date establishes the billing cycle start date. |
24 |
lastBillingDate
|
Date |
|
|
|
|
Final date when billing will occur for this subscription.\n\r\n> **Note:** This field is only included for subscriptions with type=F (Fixed). Format must be yyyy-MM-dd. |
25 |
lastUpdateDate
|
Datetime |
|
|
|
|
Date and time when the subscription was last modified.\n\r\n> **Note:** This value is returned in yyyy-MM-dd HH:mm:ss format. Matches createDate for newly created subscriptions. |
26 |
length
|
Integer |
|
|
|
|
Number of billing cycles for which the subscription will be active.\n\r\n> **Note:** This field is only included for subscriptions with type=F (Fixed). The maximum value depends on the billingCycleType: A (Annual) - 3, S (Semi-annual) - 6, Q (Quarterly) - 12, M (Monthly) - 36, W (Weekly) - 153. |
27 |
nextBillingDate
|
Date |
|
|
|
|
Date when the next billing will occur for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This value is automatically calculated based on the billing cycle and the firstBillingDate. |
28 |
note
|
String(255) |
|
|
|
|
Additional information or comments about this subscription.\n\r\n> **Note:** This field is only included if a note was provided in the request. |
29 |
paymentOptionId
|
Reference |
|
|
|
|
Reference to the customer's payment method that will be used to collect subscription payments.\n\r\n> **Note:** This is the payment method that will be charged according to the subscription schedule. |
30 |
planId
|
Reference |
|
|
|
|
Reference to the payment plan this subscription is based on.\n\r\n> **Note:** The plan defines the base pricing and billing terms for this subscription. |
31 |
status
|
|
|
|
|
|
Current status of the subscription in the system.\n\r\n> **Note:** For new subscriptions, this is typically set to "Current" or "Unbilled" depending on the billing schedule. |
32 |
type
|
|
|
|
|
|
Type of subscription - either fixed-term or perpetual (ongoing).\n\r\n> **Note:** F (Fixed) indicates a subscription with a defined end date, while P (Perpetual) indicates an ongoing subscription. |
33 |
billingCycleType
|
|
|
|
|
|
Frequency at which the customer will be billed for this subscription.\n\r\n> **Note:** Common values include M (Monthly), A (Annual), Q (Quarterly), etc. |
34 |
pendingAdjustmentEffectiveDate
|
Date |
|
|
|
|
Date when the scheduled change will take effect.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if pendingAdjustmentType is present. |
35 |
pendingAdjustmentNote
|
String(255) |
|
|
|
|
Additional information about the scheduled adjustment.\n\r\n> **Note:** This field is only included if pendingAdjustmentType is present. |
36 |
pendingAdjustmentLength
|
Integer |
|
|
|
|
Number of billing cycles for which the adjustment will apply.\n\r\n> **Note:** This field is only included if pendingAdjustmentType is F (Freeze). |
37 |
code
|
String(60) |
|
|
|
|
Secondary identifier for the subscription that references an ID in your own system.\n\r\n> **Note:** If you didn't provide a value in the request, this will be set to the same value as the id field.\n\r\n> **Tip:** Use this field to cross-reference subscriptions between systems. |
38 |
planName
|
String |
|
|
|
|
Name of the payment plan associated with this subscription.\n\r\n> **Note:** This value is derived from the referenced planId and provides a human-readable identifier. |
39 |
nextInvoicingDate
|
Date |
|
|
|
|
Date when the next invoice will be generated for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if relevant to the subscription's current state. |
40 |
firstInvoicingDate
|
Date |
|
|
|
|
Date when the first invoice will be generated for this subscription.\n\r\n> **Note:** Format must be yyyy-MM-dd. This field is only included if invoicing is configured separately from billing. |
41 |
taxAmount
|
Integer |
|
|
|
|
Tax amount (in cents) that will be applied to each billing cycle.\n\r\n> **Note:** This field is only included if tax calculation is enabled for this subscription. |
42 |
planName
|
String |
|
|
|
|
Name of the payment plan associated with this subscription.\n\r\n> **Note:** This value is derived from the referenced planId and provides a human-readable identifier. |
|