Deletes an advance invoicing schedule. When schedule_type = specific_dates, you also have the option of deleting a part of the schedule.

Note: This operation optionally supports 3DS verification flow. To achieve the same, create the Payment Intent and pass it as input parameter to this API.

This API is used to resume a paused subscription. On resumption the subscription will be activated and any applicable charges will be initiated.

You could schedule the resumption by passing specific_date parameter in resume_option. If scheduled, the subscription will be resumed on the specific_date and moved to Active state.

For in-term resumption, unless there are scheduled changes, unbilled charges will not be charged.

What is an "in-term resumption"?
An "in-term resumption" is when the pause and resumption happens within the billing term of the subscription.

Example : A subscription was billed from 1st to 31st of a month. It was paused on the 20th and resumed before 31st. This is an in-term resumption.

UNPAID INVOICES

Specifying unpaid_invoices allows you to close invoices of the subscription which have amounts due. The invoices are chosen for payment collection after applying the available credits and excess payments.

If specified as schedule_payment_collection, payment collection for the amount due of past invoices will be attempted. The payment method available will be charged if auto-collection is enabled for the customer, and appropriate payment collection(payment succeeded or payment failed) events will be triggered. If the payment collection fails, no further retries will be made on the invoices.

Note: If the invoices of the subscription are consolidated, and any of the subscriptions in the consolidated invoice are cancelled, these invoices will not be selected for collection.

Note: This endpoint optionally supports 3DS. To use it, create a payment_intent and provide it via this endpoint.

Updates the specified subscription by setting the parameters passed. Any parameters not provided are left unmodified. If an invoice is generated for this operation, any available credits and excess payments for the customer are automatically applied.

Regenerates the current invoice for the subscription. The current invoice is that which includes non-metered items from the current term and metered items from the previous term of the subscription.

prerequisites

• The current invoice of the subscription must have been voided or deleted.
• The subscription status must be active or non_renewing.
• There should be no unbilled charges for non-metered items for the current term.
• There should be no unbilled charges for metered items for the previous term.
• The subscription must not have any advance invoice or advance invoice schedule.

deleting an invoice

Usages are also deleted when an invoice is deleted. Therefore, if the invoice was deleted, you may add or bulk import usages before regenerating an invoice.

Removes Coupons associated with the Subscription. If the param 'coupon_ids' is not specified, all the Coupons linked to the Subscription will be removed.

Cancels the subscription.

Canceling contract terms

• Subscriptions with contract terms can only be canceled by terminating the contract term.
• When canceling a contract term, the default value for the following parameters is taken from the site settings for contract terms instead of the site settings for subscription cancellation.
  • credit_option_for_current_term_charges
  • unbilled_charges_option
  • account_receivables_handling
  • refundable_credits_handling
• From among the parameters for this request, end_of_term or cancel_at should not be passed when using contract terms; use contract_term_cancel_option instead.
• The subscription_items parameter is used to override price or quantity for the termination fee. To use this parameter, the following two conditions must be met:
  • contract_term_cancel_option must be set to terminate_now.
  • the subscription must have a subscription_items attribute with charge_on_event set to contract_term_termination.