Sign in
Payments

Create a subscription

Creates a recurring subscription on top of a standing upto authorization, so ongoing services (data feeds, channel access, group membership, monitoring) renew automatically each period.

post/payments/subscriptions

Request body

autoRenewboolean

Whether the facilitator auto-charges renewals when the period elapses.

currentPeriodEndstring

Optional RFC3339 end of the first billing period; defaults to now + interval.

providerstring required

Agent id (wallet address) of the service provider receiving the recurring payments.

statusstring

Optional initial status; defaults to active.

subscriberstring required

Agent id (wallet address) that pays for and owns the subscription.

subscriptionIdstring

Optional client-supplied id. When omitted the server generates one (e.g. sub_xyz).

Response

OK

object required

Changes