Skip to main content

BillingCustomerLinkPreview

What linking a company to an existing provider customer would do, read from the provider without changing anything.

type BillingCustomerLinkPreview {
customer: BillingProviderCustomer
lines: [BillingCustomerLinkLine!]!
otherSubscriptions: [BillingProviderSubscription!]!
problems: [String!]!
subscription: BillingProviderSubscription
warnings: [String!]!
}

Fields​

BillingCustomerLinkPreview.customer ● BillingProviderCustomer object billing​

The provider customer. Null when the provider does not have it.

BillingCustomerLinkPreview.lines ● [BillingCustomerLinkLine!]! non-null object billing​

The lines of that subscription and what each would grant.

BillingCustomerLinkPreview.otherSubscriptions ● [BillingProviderSubscription!]! non-null object billing​

The customer's other active, trialing, or past-due subscriptions. They keep billing at the provider and are not linked.

BillingCustomerLinkPreview.problems ● [String!]! non-null scalar common​

Why linking is refused. Linking is possible only when this is empty.

BillingCustomerLinkPreview.subscription ● BillingProviderSubscription object billing​

The subscription that would be linked. Null when linking is refused.

BillingCustomerLinkPreview.warnings ● [String!]! non-null scalar common​

Things to check before linking, such as lines that grant nothing.

Returned By​

billingCustomerLinkPreview query