expresspayments
Version:
ExpressPayments API wrapper
908 lines (756 loc) • 90 kB
TypeScript
// File generated from our OpenAPI spec
declare module 'expresspayments' {
namespace ExpressPayments {
interface SubscriptionCreateParams {
/**
* The identifier of the customer to subscribe.
*/
customer: string;
/**
* A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
*/
add_invoice_items?: Array<SubscriptionCreateParams.AddInvoiceItem>;
/**
* A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's ExpressPayments account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://docs.epayments.network/connect/subscriptions#collecting-fees-on-subscriptions).
*/
application_fee_percent?: number;
/**
* Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.
*/
automatic_tax?: SubscriptionCreateParams.AutomaticTax;
/**
* For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.
*/
backdate_start_date?: number;
/**
* A future timestamp to anchor the subscription's [billing cycle](https://docs.epayments.network/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. The timestamp is in UTC format.
*/
billing_cycle_anchor?: number;
/**
* Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
*/
billing_thresholds?: ExpressPayments.Emptyable<
SubscriptionCreateParams.BillingThresholds
>;
/**
* A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
*/
cancel_at?: number;
/**
* Boolean indicating whether this subscription should cancel at the end of the current period.
*/
cancel_at_period_end?: boolean;
/**
* Either `charge_automatically`, or `send_invoice`. When charging automatically, ExpressPayments will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, ExpressPayments will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.
*/
collection_method?: SubscriptionCreateParams.CollectionMethod;
/**
* The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.
*/
coupon?: string;
/**
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://docs.epayments.network/currencies).
*/
currency?: string;
/**
* Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.
*/
days_until_due?: number;
/**
* ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.epayments.network/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.epayments.network/api/customers/object#customer_object-default_source).
*/
default_payment_method?: string;
/**
* ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.epayments.network/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.epayments.network/api/customers/object#customer_object-default_source).
*/
default_source?: string;
/**
* The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription.
*/
default_tax_rates?: ExpressPayments.Emptyable<Array<string>>;
/**
* The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in ExpressPayments surfaces.
*/
description?: string;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* A list of up to 20 subscription items, each with an attached price.
*/
items?: Array<SubscriptionCreateParams.Item>;
/**
* Set of [key-value pairs](https://docs.epayments.network/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
*/
metadata?: ExpressPayments.Emptyable<ExpressPayments.MetadataParam>;
/**
* Indicates if a customer is on or off-session while an invoice payment is attempted.
*/
off_session?: boolean;
/**
* The account on behalf of which to charge, for each of the subscription's invoices.
*/
on_behalf_of?: ExpressPayments.Emptyable<string>;
/**
* Only applies to subscriptions with `collection_method=charge_automatically`.
*
* Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice cannot be paid. Creating subscriptions with this status allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://docs.epayments.network/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
*
* Use `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the payment intent on the first invoice. This allows simpler management of scenarios where additional user actions are needed to pay a subscription's invoice. Such as failed payments, [SCA regulation](https://docs.epayments.network/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the payment intent is not confirmed within 23 hours subscriptions transition to `status=incomplete_expired`, which is a terminal state.
*
* Use `error_if_incomplete` if you want ExpressPayments to return an HTTP 402 status code if a subscription's first invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not create a subscription and returns an error instead. This was the default behavior for API versions prior to 2022-12-31. See the [changelog](https://docs.epayments.network/upgrades#2022-12-31) to learn more.
*
* `pending_if_incomplete` is only used with updates and cannot be passed when creating a subscription.
*
* Subscriptions with `collection_method=send_invoice` are automatically activated regardless of the first invoice status.
*/
payment_behavior?: SubscriptionCreateParams.PaymentBehavior;
/**
* Payment settings to pass to invoices created by the subscription.
*/
payment_settings?: SubscriptionCreateParams.PaymentSettings;
/**
* Specifies an interval for how often to bill for any pending invoice items. It is analogous to call [Create an invoice](https://docs.epayments.network/api#create_invoice) for the given subscription at the specified interval.
*/
pending_invoice_item_interval?: ExpressPayments.Emptyable<
SubscriptionCreateParams.PendingInvoiceItemInterval
>;
/**
* The API ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription.
*/
promotion_code?: string;
/**
* Determines how to handle [prorations](https://docs.epayments.network/subscriptions/billing-cycle#prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.
*/
proration_behavior?: SubscriptionCreateParams.ProrationBehavior;
/**
* If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.
*/
transfer_data?: SubscriptionCreateParams.TransferData;
/**
* Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://docs.epayments.network/billing/subscriptions/trials) to learn more.
*/
trial_end?: 'now' | number;
/**
* Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://docs.epayments.network/billing/subscriptions/trials) to learn more.
*/
trial_from_plan?: boolean;
/**
* Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://docs.epayments.network/billing/subscriptions/trials) to learn more.
*/
trial_period_days?: number;
/**
* Settings related to subscription trials.
*/
trial_settings?: SubscriptionCreateParams.TrialSettings;
}
namespace SubscriptionCreateParams {
interface AddInvoiceItem {
/**
* The ID of the price object.
*/
price?: string;
/**
* Data used to generate a new [Price](https://docs.epayments.network/api/prices) object inline.
*/
price_data?: AddInvoiceItem.PriceData;
/**
* Quantity for this item. Defaults to 1.
*/
quantity?: number;
/**
* The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
*/
tax_rates?: ExpressPayments.Emptyable<Array<string>>;
}
namespace AddInvoiceItem {
interface PriceData {
/**
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://docs.epayments.network/currencies).
*/
currency: string;
/**
* The ID of the product that this price will belong to.
*/
product: string;
/**
* Only required if a [default tax behavior](https://docs.epayments.network/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the ExpressPayments Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
*/
tax_behavior?: PriceData.TaxBehavior;
/**
* A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
*/
unit_amount?: number;
/**
* Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
*/
unit_amount_decimal?: string;
}
namespace PriceData {
type TaxBehavior =
| 'exclusive'
| 'inclusive'
| 'unspecified';
}
}
interface AutomaticTax {
/**
* Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
*/
enabled: boolean;
}
interface BillingThresholds {
/**
* Monetary threshold that triggers the subscription to advance to a new billing period
*/
amount_gte?: number;
/**
* Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.
*/
reset_billing_cycle_anchor?: boolean;
}
type CollectionMethod = 'charge_automatically' | 'send_invoice';
interface Item {
/**
* Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
*/
billing_thresholds?: ExpressPayments.Emptyable<
Item.BillingThresholds
>;
/**
* Set of [key-value pairs](https://docs.epayments.network/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
*/
metadata?: ExpressPayments.MetadataParam;
/**
* Plan ID for this item, as a string.
*/
plan?: string;
/**
* The ID of the price object.
*/
price?: string;
/**
* Data used to generate a new [Price](https://docs.epayments.network/api/prices) object inline.
*/
price_data?: Item.PriceData;
/**
* Quantity for this item.
*/
quantity?: number;
/**
* A list of [Tax Rate](https://docs.epayments.network/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.epayments.network/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
*/
tax_rates?: ExpressPayments.Emptyable<Array<string>>;
}
namespace Item {
interface BillingThresholds {
/**
* Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://docs.epayments.network/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
*/
usage_gte: number;
}
interface PriceData {
/**
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://docs.epayments.network/currencies).
*/
currency: string;
/**
* The ID of the product that this price will belong to.
*/
product: string;
/**
* The recurring components of a price such as `interval` and `interval_count`.
*/
recurring: PriceData.Recurring;
/**
* Only required if a [default tax behavior](https://docs.epayments.network/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the ExpressPayments Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
*/
tax_behavior?: PriceData.TaxBehavior;
/**
* A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
*/
unit_amount?: number;
/**
* Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
*/
unit_amount_decimal?: string;
}
namespace PriceData {
interface Recurring {
/**
* Specifies billing frequency. Either `day`, `week`, `month` or `year`.
*/
interval: Recurring.Interval;
/**
* The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one-year interval allowed (1 year, 12 months, or 52 weeks).
*/
interval_count?: number;
}
namespace Recurring {
type Interval = 'day' | 'month' | 'week' | 'year';
}
type TaxBehavior =
| 'exclusive'
| 'inclusive'
| 'unspecified';
}
}
type PaymentBehavior =
| 'allow_incomplete'
| 'default_incomplete'
| 'error_if_incomplete'
| 'pending_if_incomplete';
interface PaymentSettings {
/**
* Payment-method-specific configuration to provide to invoices created by the subscription.
*/
payment_method_options?: PaymentSettings.PaymentMethodOptions;
/**
* The list of payment method types (e.g. card) to provide to the invoice's PaymentIntent. If not set, ExpressPayments attempts to automatically determine the types to use by looking at the invoice's default payment method, the subscription's default payment method, the customer's default payment method, and your [invoice template settings](https://dashboard.epayments.network/settings/billing/invoice).
*/
payment_method_types?: ExpressPayments.Emptyable<
Array<PaymentSettings.PaymentMethodType>
>;
/**
* Either `off`, or `on_subscription`. With `on_subscription` ExpressPayments updates `subscription.default_payment_method` when a subscription payment succeeds.
*/
save_default_payment_method?: PaymentSettings.SaveDefaultPaymentMethod;
}
namespace PaymentSettings {
interface PaymentMethodOptions {
/**
* This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice's PaymentIntent.
*/
acss_debit?: ExpressPayments.Emptyable<
PaymentMethodOptions.AcssDebit
>;
/**
* This sub-hash contains details about the Bancontact payment method options to pass to the invoice's PaymentIntent.
*/
bancontact?: ExpressPayments.Emptyable<
PaymentMethodOptions.Bancontact
>;
/**
* This sub-hash contains details about the Card payment method options to pass to the invoice's PaymentIntent.
*/
card?: ExpressPayments.Emptyable<PaymentMethodOptions.Card>;
/**
* This sub-hash contains details about the Bank transfer payment method options to pass to the invoice's PaymentIntent.
*/
customer_balance?: ExpressPayments.Emptyable<
PaymentMethodOptions.CustomerBalance
>;
/**
* This sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
*/
konbini?: ExpressPayments.Emptyable<
PaymentMethodOptions.Konbini
>;
/**
* This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice's PaymentIntent.
*/
us_bank_account?: ExpressPayments.Emptyable<
PaymentMethodOptions.UsBankAccount
>;
}
namespace PaymentMethodOptions {
interface AcssDebit {
/**
* Additional fields for Mandate creation
*/
mandate_options?: AcssDebit.MandateOptions;
/**
* Verification method for the intent
*/
verification_method?: AcssDebit.VerificationMethod;
}
namespace AcssDebit {
interface MandateOptions {
/**
* Transaction type of the mandate.
*/
transaction_type?: MandateOptions.TransactionType;
}
namespace MandateOptions {
type TransactionType = 'business' | 'personal';
}
type VerificationMethod =
| 'automatic'
| 'instant'
| 'microdeposits';
}
interface Bancontact {
/**
* Preferred language of the Bancontact authorization page that the customer is redirected to.
*/
preferred_language?: Bancontact.PreferredLanguage;
}
namespace Bancontact {
type PreferredLanguage = 'de' | 'en' | 'fr' | 'nl';
}
interface Card {
/**
* Configuration options for setting up an eMandate for cards issued in India.
*/
mandate_options?: Card.MandateOptions;
/**
* Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.
*/
network?: Card.Network;
/**
* We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://docs.epayments.network/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://docs.epayments.network/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
*/
request_three_d_secure?: Card.RequestThreeDSecure;
}
namespace Card {
interface MandateOptions {
/**
* Amount to be charged for future payments.
*/
amount?: number;
/**
* One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
*/
amount_type?: MandateOptions.AmountType;
/**
* A description of the mandate or subscription that is meant to be displayed to the customer.
*/
description?: string;
}
namespace MandateOptions {
type AmountType = 'fixed' | 'maximum';
}
type Network =
| 'amex'
| 'cartes_bancaires'
| 'diners'
| 'discover'
| 'eftpos_au'
| 'interac'
| 'jcb'
| 'mastercard'
| 'unionpay'
| 'unknown'
| 'visa';
type RequestThreeDSecure = 'any' | 'automatic';
}
interface CustomerBalance {
/**
* Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
*/
bank_transfer?: CustomerBalance.BankTransfer;
/**
* The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
*/
funding_type?: string;
}
namespace CustomerBalance {
interface BankTransfer {
/**
* Configuration for eu_bank_transfer funding type.
*/
eu_bank_transfer?: BankTransfer.EuBankTransfer;
/**
* The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
*/
type?: string;
}
namespace BankTransfer {
interface EuBankTransfer {
/**
* The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
*/
country: string;
}
}
}
interface Konbini {}
interface UsBankAccount {
/**
* Additional fields for Financial Connections Session creation
*/
financial_connections?: UsBankAccount.FinancialConnections;
/**
* Verification method for the intent
*/
verification_method?: UsBankAccount.VerificationMethod;
}
namespace UsBankAccount {
interface FinancialConnections {
/**
* The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
*/
permissions?: Array<
FinancialConnections.Permission
>;
}
namespace FinancialConnections {
type Permission =
| 'balances'
| 'ownership'
| 'payment_method'
| 'transactions';
}
type VerificationMethod =
| 'automatic'
| 'instant'
| 'microdeposits';
}
}
type PaymentMethodType =
| 'ach_credit_transfer'
| 'ach_debit'
| 'acss_debit'
| 'au_becs_debit'
| 'bacs_debit'
| 'bancontact'
| 'boleto'
| 'card'
| 'cashapp'
| 'customer_balance'
| 'fpx'
| 'giropay'
| 'grabpay'
| 'ideal'
| 'konbini'
| 'link'
| 'paynow'
| 'paypal'
| 'promptpay'
| 'sepa_credit_transfer'
| 'sepa_debit'
| 'sofort'
| 'us_bank_account'
| 'wechat_pay';
type SaveDefaultPaymentMethod = 'off' | 'on_subscription';
}
interface PendingInvoiceItemInterval {
/**
* Specifies invoicing frequency. Either `day`, `week`, `month` or `year`.
*/
interval: PendingInvoiceItemInterval.Interval;
/**
* The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one-year interval allowed (1 year, 12 months, or 52 weeks).
*/
interval_count?: number;
}
namespace PendingInvoiceItemInterval {
type Interval = 'day' | 'month' | 'week' | 'year';
}
type ProrationBehavior =
| 'always_invoice'
| 'create_prorations'
| 'none';
interface TransferData {
/**
* A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
*/
amount_percent?: number;
/**
* ID of an existing, connected ExpressPayments account.
*/
destination: string;
}
interface TrialSettings {
/**
* Defines how the subscription should behave when the user's free trial ends.
*/
end_behavior: TrialSettings.EndBehavior;
}
namespace TrialSettings {
interface EndBehavior {
/**
* Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
*/
missing_payment_method: EndBehavior.MissingPaymentMethod;
}
namespace EndBehavior {
type MissingPaymentMethod =
| 'cancel'
| 'create_invoice'
| 'pause';
}
}
}
interface SubscriptionRetrieveParams {
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
}
interface SubscriptionUpdateParams {
/**
* A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
*/
add_invoice_items?: Array<SubscriptionUpdateParams.AddInvoiceItem>;
/**
* A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's ExpressPayments account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://docs.epayments.network/connect/subscriptions#collecting-fees-on-subscriptions).
*/
application_fee_percent?: number;
/**
* Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.
*/
automatic_tax?: SubscriptionUpdateParams.AutomaticTax;
/**
* Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://docs.epayments.network/billing/subscriptions/billing-cycle).
*/
billing_cycle_anchor?: SubscriptionUpdateParams.BillingCycleAnchor;
/**
* Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
*/
billing_thresholds?: ExpressPayments.Emptyable<
SubscriptionUpdateParams.BillingThresholds
>;
/**
* A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
*/
cancel_at?: ExpressPayments.Emptyable<number>;
/**
* Boolean indicating whether this subscription should cancel at the end of the current period.
*/
cancel_at_period_end?: boolean;
/**
* Details about why this subscription was cancelled
*/
cancellation_details?: SubscriptionUpdateParams.CancellationDetails;
/**
* Either `charge_automatically`, or `send_invoice`. When charging automatically, ExpressPayments will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, ExpressPayments will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.
*/
collection_method?: SubscriptionUpdateParams.CollectionMethod;
/**
* The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.
*/
coupon?: string;
/**
* Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.
*/
days_until_due?: number;
/**
* ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.epayments.network/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.epayments.network/api/customers/object#customer_object-default_source).
*/
default_payment_method?: string;
/**
* ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.epayments.network/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.epayments.network/api/customers/object#customer_object-default_source).
*/
default_source?: string;
/**
* The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. Pass an empty string to remove previously-defined tax rates.
*/
default_tax_rates?: ExpressPayments.Emptyable<Array<string>>;
/**
* The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in ExpressPayments surfaces.
*/
description?: string;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* A list of up to 20 subscription items, each with an attached price.
*/
items?: Array<SubscriptionUpdateParams.Item>;
/**
* Set of [key-value pairs](https://docs.epayments.network/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
*/
metadata?: ExpressPayments.Emptyable<ExpressPayments.MetadataParam>;
/**
* Indicates if a customer is on or off-session while an invoice payment is attempted.
*/
off_session?: boolean;
/**
* The account on behalf of which to charge, for each of the subscription's invoices.
*/
on_behalf_of?: ExpressPayments.Emptyable<string>;
/**
* If specified, payment collection for this subscription will be paused.
*/
pause_collection?: ExpressPayments.Emptyable<
SubscriptionUpdateParams.PauseCollection
>;
/**
* Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://docs.epayments.network/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
*
* Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription's invoice. Such as failed payments, [SCA regulation](https://docs.epayments.network/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.
*
* Use `pending_if_incomplete` to update the subscription using [pending updates](https://docs.epayments.network/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://docs.epayments.network/billing/pending-updates-reference#supported-attributes).
*
* Use `error_if_incomplete` if you want ExpressPayments to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2022-12-31. See the [changelog](https://docs.epayments.network/upgrades#2019-03-14) to learn more.
*/
payment_behavior?: SubscriptionUpdateParams.PaymentBehavior;
/**
* Payment settings to pass to invoices created by the subscription.
*/
payment_settings?: SubscriptionUpdateParams.PaymentSettings;
/**
* Specifies an interval for how often to bill for any pending invoice items. It is analogous to call [Create an invoice](https://docs.epayments.network/api#create_invoice) for the given subscription at the specified interval.
*/
pending_invoice_item_interval?: ExpressPayments.Emptyable<
SubscriptionUpdateParams.PendingInvoiceItemInterval
>;
/**
* The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription.
*/
promotion_code?: string;
/**
* Determines how to handle [prorations](https://docs.epayments.network/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
*/
proration_behavior?: SubscriptionUpdateParams.ProrationBehavior;
/**
* If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://docs.epayments.network/api#upcoming_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations.
*/
proration_date?: number;
/**
* If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value.
*/
transfer_data?: ExpressPayments.Emptyable<
SubscriptionUpdateParams.TransferData
>;
/**
* Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`.
*/
trial_end?: 'now' | number;
/**
* Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://docs.epayments.network/billing/subscriptions/trials) to learn more.
*/
trial_from_plan?: boolean;
/**
* Settings related to subscription trials.
*/
trial_settings?: SubscriptionUpdateParams.TrialSettings;
}
namespace SubscriptionUpdateParams {
interface AddInvoiceItem {
/**
* The ID of the price object.
*/
price?: string;
/**
* Data used to generate a new [Price](https://docs.epayments.network/api/prices) object inline.
*/
price_data?: AddInvoiceItem.PriceData;
/**
* Quantity for this item. Defaults to 1.
*/
quantity?: number;
/**
* The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
*/
tax_rates?: ExpressPayments.Emptyable<Array<string>>;
}
namespace AddInvoiceItem {
interface PriceData {
/**
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://docs.epayments.network/currencies).
*/
currency: string;
/**
* The ID of the product that this price will belong to.
*/
product: string;
/**
* Only required if a [default tax behavior](https://docs.epayments.network/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the ExpressPayments Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
*/
tax_behavior?: PriceData.TaxBehavior;
/**
* A positive integer in cents (or local equivalent) (or 0 for a free price) representing h