ChargebeeAPI

Local delete a payment source

Idempotency Supported
Try in API Explorer

Delete a payment source reference from a Chargebee customer without deleting or altering payment source data stored at the payment gateway.

Impacts

Payment Source

Sets deleted = true on the specified payment_source and detaches it from the customer. The payment source is no longer accessible through the API or the UI.

Customer

If the deleted payment_source is the customer's only payment method and auto_collection is on, automatic payment collection for future invoices fails.

If the deleted payment source was the primary payment method for the customer, and a backup exists, Chargebee promotes the backup to primary.

If no backup is set but other payment_source objects exist for the customer, Chargebee promotes one of them to primary.

Subscription

When you delete a payment source linked to an active subscription, Chargebee immediately clears the payment_source_id on that subscription. Future charges use the customer's primary_payment_source_id.

Sample Request

URL Format

POST https://[site].chargebee.com/api/v2/payment_sources/{cust-payment-source-id}/delete_local

Returns

customerCustomer object

Resource object representing customer

payment_sourcePayment source object

Resource object representing payment_source