Magidoc

SubscriptionQuery
Object

Query for subscriptions

Fields

#

additionalMetaData

JSON

addons

[ SubscriptionAddon !]

billingCycleAnchor

DateTime

Billing cycle anchor date

billingId

String

billingLinkUrl

String

billingSyncError

String

budget

BudgetConfiguration

Budget configuration

budgetExceeded

Boolean

Indicates if the budget has been exceeded

cancelReason

SubscriptionCancelReason

cancellationDate

DateTime

coupon

SubscriptionCoupon

coupons

[ SubscriptionCoupon !]

createdAt

DateTime

Created at

crmId

String

crmLinkUrl

String

currentBillingPeriodEnd

DateTime

currentBillingPeriodStart

DateTime

customer

Customer !
Non-null

customerId

String

Customer ID

effectiveEndDate

DateTime

endDate

DateTime

environment

Environment !
Non-null

environmentId

UUID !
Non-null

Environment ID

experiment

Experiment

experimentInfo

experimentInfo

freeItems

[ FreeSubscriptionItem !]

Free items included in the subscription

id

UUID !
Non-null

lastUsageInvoice

SubscriptionInvoice

latestInvoice

SubscriptionInvoice

minimumSpend

SubscriptionMinimumSpend

Minimum spend configuration

oldBillingId

String

payingCustomer

Customer

payingCustomerId

UUID

paymentCollection

PaymentCollection !
Non-null

paymentCollectionMethod

PaymentCollectionMethod

Payment collection method of the subscription

plan

Plan !
Non-null

prices

[ SubscriptionPrice !]

pricingType

PricingType !
Non-null

refId

String !
Non-null

resource

CustomerResource

resourceId

String

Resource ID

salesforceId

String

scheduledUpdates

[ SubscriptionScheduledUpdate !]

startDate

DateTime !
Non-null

status

SubscriptionStatus !
Non-null

Subscription status

subscriptionEntitlements

[ SubscriptionEntitlement !]

subscriptionId

String !
Non-null

syncStates

[ SyncState !]!
Non-null

totalPrice

CustomerSubscriptionTotalPrice

trialConfiguration

TrialConfiguration

Trial configuration

trialEndDate

DateTime

wasInTrial

Boolean

Usages

#

References

#