Skip to main content
GET
List payment options

Authorizations

Authorization
string
header
required

Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.

Query Parameters

renews
boolean
default:false

The value of renews.

Example:

true

Response

The whole set, as a JSON array. There is no envelope and no paging.

value
string
required

The enum's own value, which is what a start request sends back.

Example:

"paddle_once"

label
string
required

A short label shown to customers.

Example:

"Credit Card or PayPal"

shortLabel
string
required

What the picker prints once a choice has been made, where the full label is too long to sit on a button.

Example:

"Credit Card or PayPal"

description
string
required

An optional description shown to customers.

Example:

"Pay once by card, PayPal or wallet. Nothing is stored and nothing renews by itself."

provider
string
required

The value of provider.

Example:

"paddle"

providerName
string
required

The value of provider_name.

Example:

"Paddle"

recurring
boolean
required

Whether choosing this hands the provider a standing schedule rather than taking one payment. Only ever offered where this invoice's amount is what falls due each cycle.

Example:

false

Examples: