Mutation
mutation CancelPaymentSubscription($input: CancelPaymentSubscriptionInput!) {
cancelPaymentSubscription(input: $input) {
clientMutationId
errors
paymentSubscription {
amount
cancelAtPeriodEnd
canceledAt
completedInstallments
createdAt
currentPeriodEnd
}
}
}Variables
{
"input": {
"subscriptionId": "id"
}
}Response
{
"data": {
"cancelPaymentSubscription": {
"clientMutationId": "string",
"errors": [
"string"
],
"paymentSubscription": {
"amount": 1,
"cancelAtPeriodEnd": true,
"canceledAt": "value",
"completedInstallments": 1,
"createdAt": "value",
"currentPeriodEnd": "value"
}
}
}
}Mutations
cancelPaymentSubscription
Cancel a member’s Payment Plan subscription. Host only.
Required scope: host:write:network_plans
MUTATION
cancelPaymentSubscription(input: CancelPaymentSubscriptionInput!): CancelPaymentSubscriptionPayloadArguments
input
required
Parameters for CancelPaymentSubscription
clientMutationId
String
A unique identifier for the client performing the mutation.
errors
[String!]!
paymentSubscription
Mutation
mutation CancelPaymentSubscription($input: CancelPaymentSubscriptionInput!) {
cancelPaymentSubscription(input: $input) {
clientMutationId
errors
paymentSubscription {
amount
cancelAtPeriodEnd
canceledAt
completedInstallments
createdAt
currentPeriodEnd
}
}
}Variables
{
"input": {
"subscriptionId": "id"
}
}Response
{
"data": {
"cancelPaymentSubscription": {
"clientMutationId": "string",
"errors": [
"string"
],
"paymentSubscription": {
"amount": 1,
"cancelAtPeriodEnd": true,
"canceledAt": "value",
"completedInstallments": 1,
"createdAt": "value",
"currentPeriodEnd": "value"
}
}
}
}