Documentation

Fields

• subscriptionChangeCreateAdd_ons :: Maybe [SubscriptionAddOnUpdate]

  add_ons: If you provide a value for this field it will replace any existing add-ons. So, when adding or modifying an add-on, you need to include the existing subscription add-ons. Unchanged add-ons can be included just using the subscription add-on''s ID: `{"id": "abc123"}`. If this value is omitted your existing add-ons will be unaffected. To remove all existing add-ons, this value should be an empty array.'

  If a subscription add-on's `code` is supplied without the `id`, `{"code": "def456"}`, the subscription add-on attributes will be set to the current values of the plan add-on unless provided in the request.

  • If an `id` is passed, any attributes not passed in will pull from the existing subscription add-on
  • If a `code` is passed, any attributes not passed in will pull from the current values of the plan add-on
  • Attributes passed in as part of the request will override either of the above scenarios
• subscriptionChangeCreateBilling_info :: Maybe SubscriptionChangeBillingInfoCreate

  billing_info

• subscriptionChangeCreateBusiness_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. Only allowed if the `timeframe` is not `now`.

• subscriptionChangeCreateBusiness_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. Only allowed if the `timeframe` is not `now`.

• subscriptionChangeCreateCollection_method :: Maybe SubscriptionChangeCreateCollection_method

  collection_method

• subscriptionChangeCreateCoupon_codes :: Maybe [Text]

  coupon_codes: A list of coupon_codes to be redeemed on the subscription during the change. Only allowed if timeframe is now and you change something about the subscription that creates an invoice.

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

• subscriptionChangeCreateNet_terms :: Maybe Int

  net_terms: Integer normally 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. During a subscription change, it's not necessary to provide both the `Net Terms Type` and `Net Terms` parameters.

  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
• subscriptionChangeCreateNet_terms_type :: Maybe SubscriptionChangeCreateNet_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.

• subscriptionChangeCreatePlan_code :: Maybe Text

  plan_code: If you want to change to a new plan, you can provide the plan's code or id. If both are provided the `plan_id` will be used.

  Constraints:

  • Maximum length of 50
• subscriptionChangeCreatePlan_id :: Maybe Text

  plan_id: If you want to change to a new plan, you can provide the plan's code or id. If both are provided the `plan_id` will be used.

  Constraints:

  • Maximum length of 13
• subscriptionChangeCreatePo_number :: Maybe Text

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

  Constraints:

  • Maximum length of 50
• subscriptionChangeCreateProration_settings :: Maybe ProrationSettings

  proration_settings: Allows you to control how any resulting charges and credits will be calculated and prorated.

• subscriptionChangeCreateQuantity :: Maybe Int

  quantity: Optionally override the default quantity of 1.

  Constraints:

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

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

• subscriptionChangeCreateRevenue_schedule_type :: Maybe SubscriptionChangeCreateRevenue_schedule_type

  revenue_schedule_type

• subscriptionChangeCreateShipping :: Maybe SubscriptionChangeShippingCreate

  shipping: Shipping addresses are tied to a customer's account. Each account can have up to 20 different shipping addresses, and if you have enabled multiple subscriptions per account, you can associate different shipping addresses to each subscription.

• subscriptionChangeCreateTax_inclusive :: Maybe Bool

  tax_inclusive: This field is deprecated. Please do not use it.

• subscriptionChangeCreateTimeframe :: Maybe SubscriptionChangeCreateTimeframe

  timeframe: The timeframe parameter controls when the upgrade or downgrade takes place. The subscription change can occur now, when the subscription is next billed, or when the subscription term ends. Generally, if you're performing an upgrade, you will want the change to occur immediately (now). If you're performing a downgrade, you should set the timeframe to `term_end` or `bill_date` so the change takes effect at a scheduled billing date. The `renewal` timeframe option is accepted as an alias for `term_end`.

• subscriptionChangeCreateTransaction_type :: Maybe SubscriptionChangeCreateTransaction_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.

• subscriptionChangeCreateUnit_amount :: Maybe Float

  unit_amount: Optionally, sets custom pricing for the subscription, overriding the plan's default unit amount. The subscription's current currency will be used.

  Constraints:

  • Maxium of 1000000.0
  • Minimum of 0.0