Subscriptions

Subscription is an arrangement to receive goods or services regularly by paying in advance.

Data Model

Field

Type

Description

Example data

id

string

Unique Identifier for each subscription.

56879

metaId

string

Id of this subscription in its origin data source (when it comes from an integration).

sub_3245

code

string

Unique code identifies the subscription (rather than using the random id field generated for each entry in our database)

YWM_SUB

parentId

string

If multiple records represent the same subscription (coming from different data sources, for example), you can choose one subscription to represent all of them and call it a parent, then assign this Id as parentId to the other subscriptions.

34599

customerId

string

Unique identifier for the customer who made this subscription.

609987152

metaCustomerId

string

Id of the customer who made this subscription in its origin data source (when it comes from an integration).

cus_KJX33C2

currencyId

string

Currency Id of this payment.

3168

metaCurrencyId

string

Currency Id of this payment in its origin data source (when it comes from an integration).

EUR

mainProductId

string

Product Id.

8652

metaMainProductId

string

Product Id of this subscription in its origin data source (when it comes from an integration).

prod_3402

status

string

Subscription status (Options: active, past_due, unpaid, canceled, incomplete, expired, trialing, future, detected, draft, pending_activation, pending_acceptance, suspended, pending).

pending_activation

originId

string

Subscriptions can be synced from subscriprion software or detected from invoices with recurring products. If the subscription is detected then its dataSourceId will be your default (manual) one. So, originId is the dataSourceId of the synced invoices that we detected this subscription from.

3214

start_date

string

Subscription start date.

2022-02-02T14:13:53.644Z

endDate

string

Subscription end date.

2022-02-02T14:13:53.644Z

billingPeriod

string

Billing period (Options: day, week, month, quarter, year, custom).

month

billingFrequency

number

Billing frequency.

1

renewalProbability

number

Renewal probability estimation as percentage from 0 to 100.

75

dataSourceId

string

Id of the data source (Manual Calqulate, or integrations).

4779

orgId

string

Organization Id in which this subscription belongs.

718987154

createdAt

string (ISO-8601 Date)

Date of creation of this entry in Calqulate's Database.

2022-02-02T14:13:53.644Z

updatedAt

string (ISO-8601 Date)

Date of last update done on this entry in Calqulate's Database.

2022-02-02T14:13:53.644Z

deletedAt

string (ISO-8601 Date)

Date of deletion of this entry from Calqulate's Database.

2022-02-02T14:13:53.644Z


Did this page help you?