Skip to main content
GET
/
v3
/
billing-methods
/
{billingMethodId}
Get billing method by ID
curl --request GET \
  --url https://api.snappy.com/v3/billing-methods/{billingMethodId} \
  --header 'X-Api-Key: <api-key>'
{
  "id": "fs_abc123",
  "name": "Q1 Marketing PO",
  "type": "PO",
  "status": "active",
  "createdAt": "2025-01-15T10:00:00.000Z",
  "expirationDate": "2025-12-31T23:59:59.000Z",
  "spendingLimit": {
    "remaining": 7250.5
  }
}

Authorizations

X-Api-Key
string
header
required

Partner API key. Finalized per partner integration agreement.

Headers

Snappy-Account-Id
string

Optional account identifier for scoping/validation/filtering.

Snappy-Company-Id
string

Optional company identifier for scoping/validation/filtering.

Path Parameters

billingMethodId
string
required

The ID of the billing method to retrieve.

Response

Billing method details.

A billing method available through the v3 public API.

id
string
required

The unique identifier of the billing method.

Example:

"fs_abc123"

name
string
required

The display name of the billing method.

Example:

"Q1 Marketing PO"

type
enum<string>
required

The type of the billing method.

Available options:
Prepay,
Invoice,
PO,
CC
Example:

"PO"

status
enum<string>
required

The current status of the billing method.

Available options:
draft,
active,
archived,
expired
Example:

"active"

createdAt
string<date-time>
required

The date the billing method was created, in ISO-8601 format.

Example:

"2025-01-15T10:00:00.000Z"

expirationDate
string<date-time> | null
required

The expiration date of the billing method, in ISO-8601 format. Null when no expiry is configured.

Example:

"2025-12-31T23:59:59.000Z"

spendingLimit
object
required

Spending limit details. Null when the billing method has no cap (e.g. Invoice).

Example:
{ "remaining": 7250.5 }
Last modified on June 6, 2026