CreateSubscriptionDto

amount
Type: number
min:
0.01
required

What to bill each cycle, in USD.
customer_id
Type: string
required

Who to bill. Our customer id, or the external_ref you gave them. They need an email address on file — that is where invoices go.
interval
Type: stringenum
required
values
weeklymonthlyquarterlyyearly
reference
Type: string
max length:
255
required

Your own handle for this agreement, unique among your subscriptions. Each invoice is referenced <reference>-<n>, so it reconciles against your books without a lookup.
allowed_rails
Type: array of "crypto" or "fiat"enum

Restrict how each invoice may be paid. Omit to offer all.
currency
Type: string

Display currency. Settlement is always USD.
cycles
Type: number
min:
1

How many cycles to bill. Omit to run until you cancel — the difference between a year's subscription and an open-ended one.
description
Type: string
max length:
500
due_days
Type: number
min:
1
max:
90

How long the customer has to pay each invoice before we start reminding them.
metadata
Type: object

Arbitrary key/value data you control.
start_at
Type: string

When the first invoice goes out, ISO-8601. Omit to bill immediately.
title
Type: string
max length:
140

Shown to the customer on the invoice and the payment page.