Skip to main content
POST
Create Policy

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-api-key
string
required

Body

application/json
name
string
required
refund_type
string
default:none
refund_percentage
number | null
refund_window_days
integer
default:0
prorate_refund
boolean
default:false
cancellation_fee
number
default:0
apply_to_existing
boolean
default:true
is_default
boolean
default:false
extra_data
Extra Data · object | null

Response

Successful Response

id
string<uuid>
required
name
string
required
refund_type
string
required
refund_percentage
number | null
required
refund_window_days
integer
required
prorate_refund
boolean
required
cancellation_fee
number
required
apply_to_existing
boolean
required
is_default
boolean
required
created_at
string<uuid>
required