# cancelRecurringBillingSubscription

Mutation · GraphQL API

Cancels a recurring billing subscription. Returns the subscription with Canceled status.

## Authentication

- SERVER

## Input

- `input` (`CancelRecurringBillingSubscriptionInput!`) — required

## Returns [RecurringBillingSubscriptionPayload](/braintree/graphql/reference/types/recurring-billing-subscription-payload)

The response object returned after a subscription-related mutation.

### Returned fields

- `clientMutationId` (`String`): An identifier used to reconcile requests and responses. 255 characters maximum.
- `subscription` (`RecurringBillingSubscription`): The subscription that was created, updated, or modified.

## Examples

### Cancel recurring billing subscription

Top-level input fields for canceling a subscription.

```graphql
mutation cancelRecurringBillingSubscription($input: CancelRecurringBillingSubscriptionInput!) {
  cancelRecurringBillingSubscription(input: $input) {
    clientMutationId
    subscription {
      __typename
      id
      legacyId
      payPalDescription
      status
      price
      balance
      billingDayOfMonth
      currentBillingCycle
      numberOfBillingCycles
      failureCount
      daysPastDue
      timeline {
        firstBillingDate
        nextBillingDate
        billingPeriodStartDate
        billingPeriodEndDate
        paidThroughDate
        createdAt
        updatedAt
      }
      nextBillingPeriodAmount
      trial {
        duration
        durationUnit
      }
      descriptor {
        companyName
        phoneNumber
        url
      }
      planId
      paymentMethodId
      merchantAccountId
      addOns {
        amount
        quantity
        currentBillingCycle
        numberOfBillingCycles
        addOnId
      }
      discounts {
        amount
        quantity
        currentBillingCycle
        numberOfBillingCycles
        discountId
      }
      transactionIds
      statusHistory {
        status
        balance
        price
        subscriptionSource
        timestamp
        planId
        currencyIsoCode
      }
    }
  }
}
```

---

[View the complete GraphQL schema on GitHub](https://raw.githubusercontent.com/braintree/graphql-api/refs/heads/master/schema.graphql)