Assign payment role

Assign or unassign the primary or backup payment role for a payment source.

Set role when creating a payment source

You can also assign a payment source as primary when you create it using APIs such as:

• Create a payment source using payment intent
• Create a payment source using temporary token
• Create a payment source using permanent token

Payment collection precedence

Chargebee uses the following precedence to determine which payment source to use when it collects payments for a subscription:

• The payment source attached to the subscription, if available.
• The primary payment source of the customer.
• The backup payment source of the customer, if available.

Prerequisites & Constraints

• The payment source must belong to the customer and must not be deleted.
• The payment source must not be the current primary payment source of the customer.
• This operation doesn't validate the status of the payment source. Check the status of the payment source before you assign it to the primary or backup role.

Impacts

Implementation Notes

Before you call this API, ensure the following:

• The payment_source.customer_id matches the id of the customer.
• The payment_source_id isn't the same as the customer.primary_payment_source_id.
• Since this API doesn't validate the status of the payment source, check the payment_source.status to ensure it isn't expired, invalid, or pending_verification.