Documentation

Fields

• subscriptionPurchaseAdd_ons :: Maybe [SubscriptionAddOnCreate]

  add_ons

• subscriptionPurchaseAuto_renew :: Maybe Bool

  auto_renew: Whether the subscription renews at the end of its term.

• subscriptionPurchaseBulk :: Maybe Bool

  bulk: Optional field to be used only when needing to bypass the 60 second limit on creating subscriptions. Should only be used when creating subscriptions in bulk from the API.

• subscriptionPurchaseCustom_fields :: Maybe CustomFields

  custom_fields: The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.

• subscriptionPurchaseNext_bill_date :: Maybe JsonDateTime

  next_bill_date: If present, this sets the date the subscription's next billing period will start (`current_period_ends_at`). This can be used to align the subscription’s billing to a specific day of the month. The initial invoice will be prorated for the period between the subscription's activation date and the billing period end date. Subsequent periods will be based off the plan interval. For a subscription with a trial period, this will change when the trial expires.

• subscriptionPurchasePlan_code :: Text

  plan_code

• subscriptionPurchasePlan_id :: Maybe Text

  plan_id

  Constraints:

  • Maximum length of 13
• subscriptionPurchaseQuantity :: Maybe Int

  quantity: Optionally override the default quantity of 1.

  Constraints:

  • Minimum of 0.0
• subscriptionPurchaseRamp_intervals :: Maybe [SubscriptionRampInterval]

  ramp_intervals: The new set of ramp intervals for the subscription.

• subscriptionPurchaseRenewal_billing_cycles :: Maybe Int

  renewal_billing_cycles: If `auto_renew=true`, when a term completes, `total_billing_cycles` takes this value as the length of subsequent terms. Defaults to the plan's `total_billing_cycles`.

• subscriptionPurchaseRevenue_schedule_type :: Maybe SubscriptionPurchaseRevenue_schedule_type

  revenue_schedule_type

• subscriptionPurchaseShipping :: Maybe SubscriptionShippingPurchase

  shipping

• subscriptionPurchaseStarts_at :: Maybe JsonDateTime

  starts_at: If set, the subscription will begin in the future on this date. The subscription will apply the setup fee and trial period, unless the plan has no trial.

• subscriptionPurchaseTax_inclusive :: Maybe Bool

  tax_inclusive: Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to use this flag.

• subscriptionPurchaseTotal_billing_cycles :: Maybe Int

  total_billing_cycles: The number of cycles/billing periods in a term. When `remaining_billing_cycles=0`, if `auto_renew=true` the subscription will renew and a new term will begin, otherwise the subscription will expire.

  Constraints:

  • Minimum of 1.0
• subscriptionPurchaseTrial_ends_at :: Maybe JsonDateTime

  trial_ends_at: If set, overrides the default trial behavior for the subscription. When the current date time or a past date time is provided the subscription will begin with no trial phase (overriding any plan default trial). When a future date time is provided the subscription will begin with a trial phase ending at the specified date time.

• subscriptionPurchaseUnit_amount :: Maybe Float

  unit_amount: Override the unit amount of the subscription plan by setting this value. If not provided, the subscription will inherit the price from the subscription plan for the provided currency.

  Constraints:

  • Maxium of 1000000.0
  • Minimum of 0.0