Skip to content

by Startups.Studio

Finance Payment Source

PaymentSource.remove

POST /{namespace}/payment-sources/{paymentSource}/remove

Remove detaches a saved Payment Source so nothing charges it again, and keeps the record.

Noun: Payment Source
Mode: do
Event: PaymentSource.removed

You, to your agent

Remove the latest payment source.

curl -X POST https://api.sb/ledgerlark.com/payment-sources/payment_source_1/remove \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const paymentSource = await $.PaymentSource.remove({ paymentSource: 'payment_source_1' })

npx startup-builder do PaymentSource.remove --json '{"paymentSource":"payment_source_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.PaymentSource.remove({ paymentSource: 'payment_source_1' })"
  }
}

Inputs

Input	Type	Required	Description
`paymentSource`	Payment Source	required	The saved Payment Source.

Outputs

Output	Type	Required	Description
`paymentSource`	Payment Source	required	The removed Payment Source, kept on record.

Effects

Emits PaymentSource.removed.
Performed by the Billing Specialist.
Two-way: it runs at once, in the try, send and do modes.
When it was the default, the most recently added remaining Payment Source becomes the default.
With none left, the next charge Invoice fails into dunning, and the Customer is asked to add one.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	PaymentSource.remove

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

PaymentSource.list

Previous Page

PaymentSource.update

Next Page