Mutation
mutation VoidPurchase($input: VoidPurchaseInput!) {
voidPurchase(input: $input) {
clientMutationId
errors
purchase {
amount
couponRedemption {
completed
coupon {
__typename
}
createdAt
id
member {
__typename
}
plan {
__typename
}
}
createdAt
currency
devicePlatform
id
}
}
}Variables
{
"input": {
"id": "id"
}
}Response
{
"data": {
"voidPurchase": {
"clientMutationId": "string",
"errors": [
"string"
],
"purchase": {
"amount": 1,
"couponRedemption": {
"completed": true,
"coupon": {
"__typename": "PaymentCoupon"
},
"createdAt": "value",
"id": "id",
"member": {
"__typename": "Member"
},
"plan": {
"__typename": "PaymentPlan"
}
},
"createdAt": "value",
"currency": "string",
"devicePlatform": "string",
"id": "id"
}
}
}
}Mutations
voidPurchase
Void a member’s one-time Payment Plan purchase — revoke their access and archive the purchase. Does not refund money.
Required scope: host:write:network_plans
MUTATION
voidPurchase(input: VoidPurchaseInput!): VoidPurchasePayloadArguments
input
required
Parameters for VoidPurchase
Returns
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
purchase
Mutation
mutation VoidPurchase($input: VoidPurchaseInput!) {
voidPurchase(input: $input) {
clientMutationId
errors
purchase {
amount
couponRedemption {
completed
coupon {
__typename
}
createdAt
id
member {
__typename
}
plan {
__typename
}
}
createdAt
currency
devicePlatform
id
}
}
}Variables
{
"input": {
"id": "id"
}
}Response
{
"data": {
"voidPurchase": {
"clientMutationId": "string",
"errors": [
"string"
],
"purchase": {
"amount": 1,
"couponRedemption": {
"completed": true,
"coupon": {
"__typename": "PaymentCoupon"
},
"createdAt": "value",
"id": "id",
"member": {
"__typename": "Member"
},
"plan": {
"__typename": "PaymentPlan"
}
},
"createdAt": "value",
"currency": "string",
"devicePlatform": "string",
"id": "id"
}
}
}
}