Request payload for creating a new subscription This struct represents the data required to create a new subscription in the system. It includes details about the product, quantity, customer information, and billing details.
Properties
Name | Type | Required | Description |
---|
| billing | model | ✅ | |
| customer | model | ✅ | |
| productId | string | ✅ | Unique identifier of the product to subscribe to |
| quantity | integer | ✅ | Number of units to subscribe for. Must be at least 1. |
| metadata | dictionary | ❌ | |
| paymentLink | boolean | ❌ | If true, generates a payment link. Defaults to false if not specified. |
| returnUrl | string | ❌ | Optional URL to redirect after successful subscription creation |
| trialPeriodDays | integer | ❌ | Optional trial period in days If specified, this value overrides the trial period set in the product's price Must be between 0 and 10000 days |