Skip to content
This repository has been archived by the owner on Mar 22, 2024. It is now read-only.

Latest commit

 

History

History
executable file
·
19 lines (15 loc) · 1.95 KB

CreateSubscription.md

File metadata and controls

executable file
·
19 lines (15 loc) · 1.95 KB

CreateSubscription

Properties

Name Type Description Notes
amount int Optional custom per quantity plan price. If provided the plan price billed for each billing period will be overridden by this price. [optional]
quantity int Optional quantity of the plan product for this subscription. If not provided the default is the default plan quantity defined for the plan. [optional]
discounts list[CreateSubscriptionDiscount] Discounts to attach to subscription [optional]
add_ons list[CreateSubscriptionAddOn] Add-ons to attach to subscription. The same add-on can only be attached to subscription once unless unique handles are supplied for the subscription add-on. [optional]
additional_costs list[CreateSubscriptionAdditionalCost] Additional costs to add to subscription at creation time [optional]
amount_incl_vat bool Whether the optional amount is including VAT. Defaults to true. [optional]
grace_duration int A grace duration in seconds from the creation of a subscription where no dunning process is started for a failing invoice. This allows a certain amount of time for the customer to sign up with a payment method. [optional]
no_trial bool Override plan trial settings and disable trial [optional]
no_setup_fee bool Override plan setup fee settings and disable fee [optional]
conditional_create bool If the subscription is eligible to bill for the first period right away, this option will make the creation conditional on a successful payment of the first invoice. Default is false. [optional]

[Back to Model list] [Back to API list] [Back to README]