Apps API · Billing Payment Methods
Billing Payment Methods: 2 endpoints
GET /api/v1/billing/payment-methods
List payment methods
Scope: billing:payment_method:read · Called with: appToken · operationId: list-billing-payment-methods
Required app scope: billing:payment_method:read.
Lists the caller org's payment methods (including pending_setup). Requires org-owner (403 AUTH_FORBIDDEN otherwise). Response wrapped in standard envelope.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
payer_ref |
query | string | Optional payer reference to scope the list |
Responses
200OK —application/json·DataResponsePaymentMethodListDTOBodydefaultError —application/problem+json·D8Error
GET /api/v1/billing/payment-options
Get offered payment methods
Scope: billing:subscription:read · Called with: appToken · operationId: get-billing-payment-options
Required app scope: billing:subscription:read.
Returns the payment methods this deployment OFFERS for the given purchase scenario, so clients render the picker from configuration instead of a hardcoded list. This is policy, not capability: an enabled method is one we choose to offer, NOT a guarantee it can be charged (that additionally depends on the price's currency and on whether the payment provider supports the method for it). Disabled entries are returned too, so a client can tell 'withheld' from 'unknown'. Served from this deployment's own configuration — unlike the rest of /billing/*, it stays available even when billing is unavailable on this deployment. Response wrapped in standard envelope.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
scenario |
query | string: subscription, credit_pack |
yes | Purchase scenario: subscription covers first subscribe and plan change; credit_pack covers one-time credit-pack purchases |
Responses
200OK —application/json·DataResponseBillingPaymentOptionsDataBodydefaultError —application/problem+json·D8Error
