Subscription

Key

Type

Description

id

integer

Internal subscription ID

uuid

string|integer

Public subscription ID

status

string

  • active
  • failed
  • cancelled
  • in_notice (see changelog)

The status of the subscription, please see Notifications (Webhooks) for more information on the status.

start

date (YYYY-MM-DD)

Start date of subscription

end

date (YYYY-MM-DD)|null

End date of subscription. Only set if subscription is cancelled.

valid_until

date (YYYY-MM-DD)

The next payment date.

paymentInterval

string

See PHP interval spec

invoice

Invoice object

See documentation

contact

Contact object

See 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,
);