Get billing method by ID

curl --request GET \
  --url https://api.snappy.com/public-api/v3/billing-methods/{billingMethodId} \
  --header 'X-Api-Key: <api-key>' \
  --header 'snappy-account-id: <snappy-account-id>'

import requests

url = "https://api.snappy.com/public-api/v3/billing-methods/{billingMethodId}"

headers = {
    "snappy-account-id": "<snappy-account-id>",
    "X-Api-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'snappy-account-id': '<snappy-account-id>', 'X-Api-Key': '<api-key>'}
};

fetch('https://api.snappy.com/public-api/v3/billing-methods/{billingMethodId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.snappy.com/public-api/v3/billing-methods/{billingMethodId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>",
    "snappy-account-id: <snappy-account-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.snappy.com/public-api/v3/billing-methods/{billingMethodId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("snappy-account-id", "<snappy-account-id>")
	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.snappy.com/public-api/v3/billing-methods/{billingMethodId}")
  .header("snappy-account-id", "<snappy-account-id>")
  .header("X-Api-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.snappy.com/public-api/v3/billing-methods/{billingMethodId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["snappy-account-id"] = '<snappy-account-id>'
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "6a2515d0982480c2a4fd6b81",
  "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
  }
}

{
  "status": 400,
  "errorCode": "400_PBLC_001",
  "message": "Bad Request"
}

{
  "status": 401,
  "errorCode": "401_PBLC_001",
  "message": "Unauthorized"
}

{
  "status": 403,
  "errorCode": "403_PBLC_001",
  "message": "Forbidden"
}

{
  "status": 404,
  "errorCode": "404_PBLC_001",
  "message": "Not Found"
}

{
  "status": 422,
  "errorCode": "422_PBLC_001",
  "message": "Unprocessable Entity"
}

Billing methods

Get billing method by ID

Use this endpoint to retrieve a single billing method by its identifier, scoped to the account specified in the Snappy-Account-Id header. Use this when you want to confirm a billing method is usable through the public API, fetch its remaining balance, or read its status and metadata before placing marketplace orders or triggering gifts.

Required parameters

billingMethodId - the billing method identifier, passed as a path parameter.

Required headers

Snappy-Account-Id - account scope.

Optional headers

Snappy-Company-Id - further scope to a specific Company.

Please note

Returns 404 if no billing method exists for the supplied billingMethodId, or if it belongs to a different account or company than the one in scope.
Returns 422 for billing methods that exist but are not supported through the public API (e.g. Express). The error envelope identifies the unsupported type.
The response includes a spendingLimit object with a remaining balance in USD dollars (e.g. 7250.5 = $7,250.50), or null when the billing method has no cap.
expirationDate is null when no expiry is configured.

Permissions

Requires: billingMethods:read

GET

billing-methods

{billingMethodId}

Get billing method by ID

curl --request GET \
  --url https://api.snappy.com/public-api/v3/billing-methods/{billingMethodId} \
  --header 'X-Api-Key: <api-key>' \
  --header 'snappy-account-id: <snappy-account-id>'

import requests

url = "https://api.snappy.com/public-api/v3/billing-methods/{billingMethodId}"

headers = {
    "snappy-account-id": "<snappy-account-id>",
    "X-Api-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'snappy-account-id': '<snappy-account-id>', 'X-Api-Key': '<api-key>'}
};

fetch('https://api.snappy.com/public-api/v3/billing-methods/{billingMethodId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.snappy.com/public-api/v3/billing-methods/{billingMethodId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>",
    "snappy-account-id: <snappy-account-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.snappy.com/public-api/v3/billing-methods/{billingMethodId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("snappy-account-id", "<snappy-account-id>")
	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.snappy.com/public-api/v3/billing-methods/{billingMethodId}")
  .header("snappy-account-id", "<snappy-account-id>")
  .header("X-Api-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.snappy.com/public-api/v3/billing-methods/{billingMethodId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["snappy-account-id"] = '<snappy-account-id>'
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "6a2515d0982480c2a4fd6b81",
  "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
  }
}

{
  "status": 400,
  "errorCode": "400_PBLC_001",
  "message": "Bad Request"
}

{
  "status": 401,
  "errorCode": "401_PBLC_001",
  "message": "Unauthorized"
}

{
  "status": 403,
  "errorCode": "403_PBLC_001",
  "message": "Forbidden"
}

{
  "status": 404,
  "errorCode": "404_PBLC_001",
  "message": "Not Found"
}

{
  "status": 422,
  "errorCode": "422_PBLC_001",
  "message": "Unprocessable Entity"
}

Authorizations

X-Api-Key

string

header

required

Company Level Authentication

Include your API key in the X-Api-Key header for every request:

X-Api-Key: YOUR_API_KEY

Headers

snappy-account-id

string

required

Account identifier.

Example:

"acc123456"

snappy-company-id

string

Optional company identifier.

Example:

"cmp123456"

Path Parameters

billingMethodId

string

required

The ID of the billing method to retrieve.

Example:

"6a2515d0982480c2a4fd6b81"

Response

Billing method details.

A single billing method.

string

required

The unique identifier of the billing method.

Example:

"6a2515d0982480c2a4fd6b81"

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 | null

required

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

Show child attributes

Example:

{ "remaining": 7250.5 }

Last modified on June 17, 2026

Get billing methods

Authentication

Marketplace

Gifting

Administration

Get billing method by ID

Permissions

Authorizations

Company Level Authentication

Headers

Path Parameters

Response