POST /payment_sources/{cust-payment-source-id}/delete_local

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

Impacts {#ImpactsOfTheOperation}

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.

Related APIs {#RelatedApis}

Delete a payment sourceList payment sources

Servers

{protocol}://{site}.{environment}:{port}/api/v2
{protocol}://{site}-test.{environment}:{port}/api/v2

Path parameters

Name	Type	Required	Description
`cust-payment-source-id`	String	Yes

Request headers

Name	Type	Required	Description
`chargebee-request-origin-device`	String	No	The device from which the customer has made the request
`chargebee-event-webhook`	String	No	skip only webhooks Possible values: `"all-disabled"`
`chargebee-business-entity-id`	String	No	If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.
`chargebee-event-actions`	String	No	skip all actions to be done on the events Possible values: `"all-disabled"`
`chargebee-request-origin-user`	String	No	The email address of your customer/user. Use this when the email address has only ASCII characters.
`chargebee-request-origin-ip`	String	No	The IP address of the customer where the request originated
`chargebee-request-origin-user-encoded`	String	No	The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header `chargebee-request-origin-user` is ignored.
`chargebee-event-email`	String	No	skip only emails Possible values: `"all-disabled"`

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.