Skip to main content

BillingProviderSubscription

A subscription as the billing provider holds it, before it is linked to a company.

type BillingProviderSubscription {
  amount: MonetaryValue
  id: String!
  notLinkedReason: String
  pastDueSince: ISO8601DateTime
  plan: BillingProduct
  status: BillingSubscriptionStatusEnum
}

Fields​

BillingProviderSubscription.amount ● MonetaryValue object common​

The recurring amount billed each period, across every line.

BillingProviderSubscription.id ● String! non-null scalar common​

The provider's subscription id, e.g. sub_123.

BillingProviderSubscription.notLinkedReason ● String scalar common​

Why this subscription would not be linked. Null for the one that would be.

BillingProviderSubscription.pastDueSince ● ISO8601DateTime scalar common​

When the unpaid invoice was finalized. Null unless the subscription is past due.

BillingProviderSubscription.plan ● BillingProduct object billing​

The catalog plan on the subscription. Null when it is not on exactly one.

BillingProviderSubscription.status ● BillingSubscriptionStatusEnum enum billing​

Lifecycle status. Null for a provider status that has no equivalent.

Member Of​

BillingCustomerLinkPreview object