Skip to main content
GET
Retrieve a payment policy

Authorizations

Authorization
string
header
required

Secret, platform or publishable API key. Platform keys require Payments-Account.

Headers

payments-account
string
payments-version
enum<string>
Available options:
2026-11-01

Path Parameters

id
string
required
Pattern: ^pol_[0-9a-hjkmnp-tv-z]{26}$

Response

Payment policy draft, active version, bindings, problems and warnings.

active_version
object | null
required
bindings
object[]
required
created_at
string
required
draft_editor_state
object | null
required
id
string
required
name
string
required
object
enum<string>
required
Available options:
payment_policy
problems
object[]
required
warnings
object[]
required
draft
any