Skip to content

by Startups.Studio

Finance Payment Source

PaymentSource.add

POST /{namespace}/payment-sources/add

Add saves a new Payment Source for a Customer through Stripe’s embedded form on the Startup’s Domain, and can make it the default.

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

You, to your agent

Add the latest payment source with a customer.

curl -X POST https://api.sb/petpantry.shop/payment-sources/add \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"customer":"customer_1","kind":"card"}'

import { $ } from 'startup-builder'

const paymentSource = await $.PaymentSource.add({ customer: 'customer_1', kind: 'card' })

npx startup-builder do PaymentSource.add --json '{"customer":"customer_1","kind":"card"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.PaymentSource.add({ customer: 'customer_1', kind: 'card' })"
  }
}

Inputs

Input	Type	Required	Description
`customer`	Customer	required	The Customer who saves it.
`kind`	`string`	required	How it pays; the form offers only the kinds the Customer’s Market accepts.
`default`	`boolean`		True to charge it for every new Invoice and renewal.

Outputs

Output	Type	Required	Description
`paymentSource`	Payment Source	required	The saved Payment Source; Stripe holds its details.

Effects

Emits PaymentSource.added.
Performed by the Billing Specialist.
Two-way: it runs at once, in the try, send and do modes.
Collects the details in Stripe’s embedded form, so the Startup never holds a card or account number.
As the new default, charges each open charge Invoice that failed at once, ahead of the next dunning retry.

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.add

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`.

Payment Source

Previous Page

PaymentSource.get

Next Page