Anchor to subscriptionBillingCycleEditDeletesubscription
subscription Billing Cycle Edit Delete
mutation
Requires access scope. Also: The user must have manage_orders_information permission.
Delete the schedule and contract edits of the selected subscription billing cycle.
Anchor to Arguments
Arguments
- Anchor to billingCycleInputbilling•
Cycle Input SubscriptionBilling Cycle Input!required Input object used to select and use billing cycles.
Was this section helpful?
Anchor to SubscriptionBillingCycleEditDeletePayload returnsSubscription Billing Cycle Edit Delete Payload returns
- Anchor to billingCyclesbilling•
Cycles The list of updated billing cycles.
- Anchor to userErrorsuser•
Errors The list of errors that occurred from executing the mutation.
Was this section helpful?
1const { admin } = await authenticate.admin(request);23const response = await admin.graphql(4 `#graphql5 mutation subscriptionBillingCycleEditDelete($contractId: ID!, $index: Int!) {6 subscriptionBillingCycleEditDelete(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {7 billingCycles {8 cycleStartAt9 cycleEndAt10 cycleIndex11 }12 userErrors {13 field14 message15 }16 }17 }`,18 {19 variables: {20 "contractId": "gid://shopify/SubscriptionContract/398475269",21 "index": 122 },23 },24);2526const data = await response.json();27
mutation subscriptionBillingCycleEditDelete($contractId: ID!, $index: Int!) {
subscriptionBillingCycleEditDelete(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {
billingCycles {
cycleStartAt
cycleEndAt
cycleIndex
}
userErrors {
field
message
}
}
}
curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation subscriptionBillingCycleEditDelete($contractId: ID!, $index: Int!) { subscriptionBillingCycleEditDelete(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) { billingCycles { cycleStartAt cycleEndAt cycleIndex } userErrors { field message } } }",
"variables": {
"contractId": "gid://shopify/SubscriptionContract/398475269",
"index": 1
}
}'
const { admin } = await authenticate.admin(request);
const response = await admin.graphql(
`#graphql
mutation subscriptionBillingCycleEditDelete($contractId: ID!, $index: Int!) {
subscriptionBillingCycleEditDelete(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {
billingCycles {
cycleStartAt
cycleEndAt
cycleIndex
}
userErrors {
field
message
}
}
}`,
{
variables: {
"contractId": "gid://shopify/SubscriptionContract/398475269",
"index": 1
},
},
);
const data = await response.json();
const client = new shopify.clients.Graphql({session});
const data = await client.query({
data: {
"query": `mutation subscriptionBillingCycleEditDelete($contractId: ID!, $index: Int!) {
subscriptionBillingCycleEditDelete(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {
billingCycles {
cycleStartAt
cycleEndAt
cycleIndex
}
userErrors {
field
message
}
}
}`,
"variables": {
"contractId": "gid://shopify/SubscriptionContract/398475269",
"index": 1
},
},
});
session = ShopifyAPI::Auth::Session.new(
shop: "your-development-store.myshopify.com",
access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
session: session
)
query = <<~QUERY
mutation subscriptionBillingCycleEditDelete($contractId: ID!, $index: Int!) {
subscriptionBillingCycleEditDelete(billingCycleInput: {contractId: $contractId, selector: {index: $index}}) {
billingCycles {
cycleStartAt
cycleEndAt
cycleIndex
}
userErrors {
field
message
}
}
}
QUERY
variables = {
"contractId": "gid://shopify/SubscriptionContract/398475269",
"index": 1
}
response = client.query(query: query, variables: variables)
Input variables
JSON1{2 "contractId": "gid://shopify/SubscriptionContract/398475269",3 "index": 14}
Response
JSON1{2 "subscriptionBillingCycleEditDelete": {3 "billingCycles": [4 {5 "cycleStartAt": "2021-12-15T15:33:01Z",6 "cycleEndAt": "2022-01-01T12:00:00Z",7 "cycleIndex": 18 }9 ],10 "userErrors": []11 }12}