Skip to main content

Choose a version:

Anchor to PartnerEvent

PartnerEvent

interface

A historical event for apps and themes.

Anchor to FieldsFields

Anchor to eventTypeeventType

non-null

The type of event.

•ID!

non-null

Unique identifier for the event.

Anchor to occurredAtoccurredAt

non-null

The date and time when the event occurred.

Anchor to shopshop

•ShopReference

The shop associated with the event.

Anchor to subjectsubject

The subject of the event (App or Theme).

Was this section helpful?

Anchor to Types implemented inTypes implemented in

Anchor to Charge Charge

•OBJECT

A charge event representing when a merchant was billed.

Anchor to amountamount

non-null

The amount the merchant was charged.

Anchor to balanceUsedbalanceUsed

The balance used for capped amount charges (legacy charges only).

Anchor to cappedAmountcappedAmount

The capped amount limit for usage-based charges (legacy charges only).

Anchor to chargeIdchargeId

•ID!

non-null

Stable identifier for this charge.

Anchor to chargeTypechargeType

non-null

The type of charge.

Anchor to descriptiondescription

Description of the charge.

Anchor to eventTypeeventType

non-null

The type of event.

•ID!

non-null

Unique identifier for the event.

Anchor to metadatametadata

•EventMetadata

Additional metadata for backfilled charges.

Anchor to occurredAtoccurredAt

non-null

The date and time when the event occurred.

Anchor to planHandleplanHandle

The plan handle associated with this charge.

Anchor to shopshop

•ShopReference

The shop associated with the event.

Anchor to subjectsubject

The subject of the event (App or Theme).

Anchor to usageQuantityusageQuantity

Quantity for usage charges.

Anchor to Credit Credit

•OBJECT

A credit event.

Anchor to descriptiondescription

Description of the credit.

Anchor to eventTypeeventType

non-null

The type of event.

•ID!

non-null

Unique identifier for the event.

Anchor to moneymoney

non-null

The credit amount.

Anchor to occurredAtoccurredAt

non-null

The date and time when the event occurred.

Anchor to shopshop

•ShopReference

The shop associated with the event.

Anchor to statusstatus

•CreditStatus!

non-null

The status of the credit.

Anchor to subjectsubject

The subject of the event (App or Theme).

Anchor to Earning Earning

•OBJECT

An earning event representing when a partner receives payment.

Anchor to chargeIdchargeId

•ID

References the charge ID from the related charge event.

Anchor to descriptiondescription

Description of the earning.

Anchor to earningTypeearningType

•EarningType!

non-null

The type of earning.

Anchor to eventTypeeventType

non-null

The type of event.

Anchor to grossAmountgrossAmount

non-null

The amount the merchant was charged.

•ID!

non-null

Unique identifier for the event.

Anchor to metadatametadata

•EventMetadata

Additional metadata for backfilled earnings.

Anchor to netAmountnetAmount

non-null

The amount the partner receives after commission.

Anchor to occurredAtoccurredAt

non-null

The date and time when the event occurred.

Anchor to settlementDatesettlementDate

The date when the earning was settled.

Anchor to shopshop

•ShopReference

The shop associated with the event.

Anchor to shopifyFeeshopifyFee

non-null

Shopify's commission.

Anchor to subjectsubject

The subject of the event (App or Theme).

Anchor to Relationship Relationship

•OBJECT

A relationship event (install, uninstall, deactivate, reactivate).

Anchor to eventTypeeventType

non-null

The type of event.

•ID!

non-null

Unique identifier for the event.

Anchor to occurredAtoccurredAt

non-null

The date and time when the event occurred.

Anchor to reasonreason

Reason for any non-installed state.

Anchor to reasonDescriptionreasonDescription

Description of the reason for any non-installed state.

Anchor to shopshop

•ShopReference

The shop associated with the event.

Anchor to statestate

•RelationshipState!

non-null

The state of the relationship.

Anchor to subjectsubject

The subject of the event (App or Theme).

Anchor to SubscriptionStatus SubscriptionStatus

•OBJECT

A subscription status event.

Anchor to cancelEffectiveOncancelEffectiveOn

Date when the subscription will actually end, if cancelled.

Anchor to eventTypeeventType

non-null

The type of event.

•ID!

non-null

Unique identifier for the event.

Anchor to occurredAtoccurredAt

non-null

The date and time when the event occurred.

Anchor to planplan

The subscription plan details.

Anchor to shopshop

•ShopReference

The shop associated with the event.

Anchor to statestate

•SubscriptionStatusState!

non-null

The state of the subscription.

Anchor to subjectsubject

The subject of the event (App or Theme).

Was this section helpful?

{

"eventType": "",

"id": "",

"occurredAt": "",

"shop": "",

"subject": ""

}

Variables

{
	"eventType": "",
	"id": "",
	"occurredAt": "",
	"shop": "",
	"subject": ""
}

Schema

interface PartnerEvent {
  eventType: EventType!
  id: ID!
  occurredAt: DateTime!
  shop: ShopReference
  subject: Subject
}