Documentation

Fields

• subscriptionUpdateAuto_renew :: Maybe Bool

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

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

• subscriptionUpdateCollection_method :: Maybe SubscriptionUpdateCollection_method

  collection_method

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

• subscriptionUpdateCustomer_notes :: Maybe Text

  customer_notes: Specify custom notes to add or override Customer Notes. Custom notes will stay with a subscription on all renewals.

• subscriptionUpdateGateway_code :: Maybe Text

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

  Constraints:

  • Maximum length of 13
• subscriptionUpdateNet_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
• subscriptionUpdateNet_terms_type :: Maybe SubscriptionUpdateNet_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.

• subscriptionUpdateNext_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. For a subscription in a trial period, this will change when the trial expires. This parameter is useful for postponement of a subscription to change its billing date without proration.

• subscriptionUpdatePo_number :: Maybe Text

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

  Constraints:

  • Maximum length of 50
• subscriptionUpdateRemaining_billing_cycles :: Maybe Int

  remaining_billing_cycles: The remaining billing cycles in the current term.

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

• subscriptionUpdateRevenue_schedule_type :: Maybe SubscriptionUpdateRevenue_schedule_type

  revenue_schedule_type

• subscriptionUpdateShipping :: Maybe SubscriptionShippingUpdate

  shipping

• subscriptionUpdateTax_inclusive :: Maybe Bool

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

• subscriptionUpdateTerms_and_conditions :: Maybe Text

  terms_and_conditions: Specify custom notes to add or override Terms and Conditions. Custom notes will stay with a subscription on all renewals.