Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

API Key authentication with required prefix "Bearer"

Path Parameters

public_id
string
required

Body

member
string
amount
string<decimal>
Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
period
enum<string>
  • annually - Annually
  • monthly - Monthly
  • weekly - Weekly
  • hourly - Hourly
Available options:
annually,
monthly,
weekly,
hourly
effective_start
string<date>
metadata
object

Up to 50 key-value pairs. Keys max 40 characters, values max 500 characters. Set a value to empty string to remove a key. On PATCH, metadata is merged with existing values.

Response

200 - application/json
id
string
required
read-only
Pattern: ^[-a-zA-Z0-9_]+$
member
string
required
amount
string<decimal>
required
Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
period
enum<string>
required
  • annually - Annually
  • monthly - Monthly
  • weekly - Weekly
  • hourly - Hourly
Available options:
annually,
monthly,
weekly,
hourly
effective_start
string<date>
required
metadata
object

Up to 50 key-value pairs. Keys max 40 characters, values max 500 characters. Set a value to empty string to remove a key. On PATCH, metadata is merged with existing values.