v1

Create Subscription Endpoint

post/v1/subscriptions

Request

  • Base URL: https://api.algovoi.co.uk (the document declares no server; this is the origin it was published from)
  • URL: https://api.algovoi.co.uk/v1/subscriptions
  • Auth: none declared

Query parameters

tenant_idstring uuid nullable

Headers

x-tenant-idstring nullable
authorizationstring nullable

Request body

customer_idstring uuid nullable
amountnumber required

Major-units fiat (e.g. 49.99 GBP) or USDC.

currencystring required

ISO 4217 (3-letter) or 'USDC'.

chainstring nullable

Override tenant's default network for this sub.

cadence'weekly' | 'monthly' | 'quarterly' | 'annual' | 'custom' required
custom_interval_daysinteger nullable
billing_anchor_dayinteger nullable
billing_timezonestring
cycle_anchor'anniversary' | 'calendar'
starts_atstring date-time nullable

First due date. Defaults to NOW() + cadence.

notify_channelsstring[]
notify_lead_hoursinteger
fx_lock_policy'send' | 'payment'
cancel_at_period_endboolean
consent_terms_versionstring nullable
consent_scopeobject
metadataobject

Response

Successful Response

idstring uuid required
tenant_idstring uuid required
customer_idstring uuid required
amount_minorinteger required
currencystring required
chainstring required
receiver_addressstring required
cadence'weekly' | 'monthly' | 'quarterly' | 'annual' | 'custom' required
custom_interval_daysinteger nullable required
billing_anchor_dayinteger nullable required
billing_timezonestring required
next_due_atstring date-time required
cycle_anchor'anniversary' | 'calendar' required
status'active' | 'past_due' | 'paused' | 'cancelled' required
paused_atstring date-time nullable required
cancelled_atstring date-time nullable required
cancel_at_period_endboolean required
notify_channelsstring[] required
notify_lead_hoursinteger required
failed_payment_policyobject required
fx_lock_policy'send' | 'payment' required
cancel_urlstring nullable
metadataobject required
created_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.