Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
PricingDashboard
GuidesAPI ReferenceCLI
API ReferenceBilling and usageBilling

List saved cards (brand/last4/exp only)

Returns the org's saved cards (id, brand, last four digits, and expiry month and year) and the id of the default card. Empty when no card is saved.

Required permission

Requires the billing.read permission. See Permissions for the roles and API key permissions that include it.

Command line

The orl CLI wraps this endpoint:

orl billing payment-method list
GET
/v1/orgs/{orgId}/billing/payment-methods

Authorization

apiKey
headerAuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer or_… (legacy vl_… keys still work).

Path Parameters

orgId*string

Response Body

Saved cards

application/json
  1. response
paymentMethods*array<>
defaultPaymentMethodId?string
Example Request
curl -X GET 'https://api.openrelay.inc/v1/orgs/string/billing/payment-methods'
Example Response
{  "paymentMethods": [    {      "id": "string",      "brand": "string",      "last4": "string",      "expMonth": 0,      "expYear": 0    }  ],  "defaultPaymentMethodId": "string"}

Set the org's auto-recharge policy PUT

Saves the org's auto-recharge settings and returns them. Turning it on needs a default saved card, an amount from $25 to $500, and a threshold of 0 or more.

Remove a saved card DELETE

Detaches a saved card from the org. Removing the default card clears the default, so no charge goes to it. A card that is not the org's returns 404.