Documentation

Fields

• subscriptionCreateAccount :: AccountCreate

  account

• subscriptionCreateAdd_ons :: Maybe [SubscriptionAddOnCreate]

  add_ons

• subscriptionCreateAuto_renew :: Maybe Bool

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

• subscriptionCreateBilling_info_id :: Maybe Text

  billing_info_id: The `billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info. `billing_info_id` can ONLY be used for sites utilizing the Wallet feature.

• subscriptionCreateBulk :: 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.

• subscriptionCreateBusiness_entity_code :: Maybe Text

  business_entity_code: The `business_entity_code` is the value that represents a specific business entity for an end customer. When `business_entity_code` is used to assign a business entity to the subscription, all future billing events for the subscription will bill to the specified business entity. Available when the `Multiple Business Entities` feature is enabled. If both `business_entity_id` and `business_entity_code` are present, `business_entity_id` will be used.

• subscriptionCreateBusiness_entity_id :: Maybe Text

  business_entity_id: The `business_entity_id` is the value that represents a specific business entity for an end customer. When `business_entity_id` is used to assign a business entity to the subscription, all future billing events for the subscription will bill to the specified business entity. Available when the `Multiple Business Entities` feature is enabled. If both `business_entity_id` and `business_entity_code` are present, `business_entity_id` will be used.

• subscriptionCreateCollection_method :: Maybe SubscriptionCreateCollection_method

  collection_method

• subscriptionCreateCoupon_codes :: Maybe [Text]

  coupon_codes: A list of coupon_codes to be redeemed on the subscription or account during the purchase.

• subscriptionCreateCredit_customer_notes :: Maybe Text

  credit_customer_notes: If there are pending credits on the account that will be invoiced during the subscription creation, these will be used as the Customer Notes on the credit invoice.

• subscriptionCreateCurrency :: Text

  currency: 3-letter ISO 4217 currency code.

  Constraints:

  • Maximum length of 3
• subscriptionCreateCustom_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.

• subscriptionCreateCustomer_notes :: Maybe Text

  customer_notes: This will default to the Customer Notes text specified on the Invoice Settings. Specify custom notes to add or override Customer Notes. Custom notes will stay with a subscription on all renewals.

• subscriptionCreateGateway_code :: Maybe Text

  gateway_code: If present, this subscription's transactions will use the payment gateway with this code.

  Constraints:

  • Maximum length of 13
• subscriptionCreateGift_card_redemption_code :: Maybe Text

  gift_card_redemption_code: A gift card redemption code to be redeemed on the purchase invoice.

• subscriptionCreateNet_terms :: Maybe Int

  net_terms: Integer paired with `Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) that the invoice will become past due. For `manual` collection method, an additional 24 hours is added to ensure the customer has the entire last day to make payment before becoming past due. For example:

  If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created. If an invoice is due `net 30`, it will become past due at 31 days exactly. If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.

  For `automatic` collection method, the additional 24 hours is not added. For example, On-Receipt is due immediately, and `net 30` will become due exactly 30 days from invoice generation, at which point Recurly will attempt collection. When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`.

  For more information on how net terms work with `manual` collection visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms) or visit (https://docs.recurly.com/docs/automatic-invoicing-terms#section-collection-terms) for information about net terms using `automatic` collection.

  Constraints:

  • Minimum of 0.0
• subscriptionCreateNet_terms_type :: Maybe SubscriptionCreateNet_terms_type

  net_terms_type: Optionally supplied string that may be either `net` or `eom` (end-of-month). When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date. When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month.

• subscriptionCreateNext_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.

• subscriptionCreatePlan_code :: Text

  plan_code: You must provide either a `plan_code` or `plan_id`. If both are provided the `plan_id` will be used.

  Constraints:

  • Maximum length of 50
• subscriptionCreatePlan_id :: Maybe Text

  plan_id: You must provide either a `plan_code` or `plan_id`. If both are provided the `plan_id` will be used.

  Constraints:

  • Maximum length of 13
• subscriptionCreatePo_number :: Maybe Text

  po_number: For manual invoicing, this identifies the PO number associated with the subscription.

  Constraints:

  • Maximum length of 50
• subscriptionCreateQuantity :: Maybe Int

  quantity: Optionally override the default quantity of 1.

  Constraints:

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

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

• subscriptionCreateRenewal_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`.

• subscriptionCreateRevenue_schedule_type :: Maybe SubscriptionCreateRevenue_schedule_type

  revenue_schedule_type

• subscriptionCreateShipping :: Maybe SubscriptionShippingCreate

  shipping

• subscriptionCreateStarts_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.

• subscriptionCreateTax_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.

• subscriptionCreateTerms_and_conditions :: Maybe Text

  terms_and_conditions: This will default to the Terms and Conditions text specified on the Invoice Settings page in your Recurly admin. Specify custom notes to add or override Terms and Conditions. Custom notes will stay with a subscription on all renewals.

• subscriptionCreateTotal_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
• subscriptionCreateTransaction_type :: Maybe SubscriptionCreateTransaction_type

  transaction_type: An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions.

• subscriptionCreateTrial_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.

• subscriptionCreateUnit_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