ChargebeeAPI

Override Billing Profile

Idempotency Supported
Try in API Explorer

Assigns the payment source and sets auto collection state for the subscription.

When you don't pass any input param for this API, payment source and auto collection for the subscription will be the same as the customer's default settings.

Sample Request

URL Format

POST https://[site].chargebee.com/api/v2/subscriptions/{subscription-id}/override_billing_profile

Input Parameters

payment_source_id
optional, string, max chars=40

Unique identifier of the payment source to be attached to this subscription.

auto_collection
optional, enumerated string

Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.

Possible Enum Values
on

Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.

off

Automatic collection of charges will not be made for this subscription. Use this for offline payments.

Returns

subscriptionSubscription object
Resource object representing subscription
payment_sourcePayment source object
Resource object representing payment_source