Subscription

KeyTypeDescription
idintegerInternal subscription ID
uuidstring|integerPublic subscription ID
statusstring
active
failed
cancelled
in_notice (see changelog)
The status of the subscription, please see Notifications (Webhooks) for more information on the status.
startdate (YYYY-MM-DD)Start date of subscription
enddate (YYYY-MM-DD)|nullEnd date of subscription. Only set if subscription is cancelled.
valid_untildate (YYYY-MM-DD)The next payment date.
paymentIntervalstringSee PHP interval spec
invoiceInvoice objectSee documentation
contactContact objectSee documentation

Example

<?php array( 'id' => 1, 'uuid' => '82m09f9', 'status' => 'active', 'start' => '2020-01-01', 'end' => null, 'valid_until' => '2021-01-01', 'paymentInterval' => 'P1Y', 'invoice' => Invoice, 'contact' => Contact, );