GET /customers/{customer-id}/create_subscription_estimate
Create a subscription for the existing estimate of a customer.
Servers
- {protocol}://{site}.{environment}:{port}/api/v1
- {protocol}://{site}-test.{environment}:{port}/api/v1
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
customer-id |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
chargebee-request-origin-device |
String | No |
The device from which the customer has made the request |
chargebee-request-origin-user |
String | No |
The email address of your customer/user. Use this when the email address has only ASCII characters. |
chargebee-request-origin-ip |
String | No |
The IP address of the customer where the request originated |
chargebee-request-origin-user-encoded |
String | No |
The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
shipping_address |
Object | No |
Parameters for shipping_address |
subscription |
Object | No |
Parameters for subscription |
use_customer_balances |
Boolean | No |
If true, all the existing balances - promotional credits, refundable credits and excess payments - will be included for the invoice estimate. Default value: false |
addons |
Object | No |
Parameters for addons |
billing_cycles |
Integer | No |
Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.