CloseTradeline

🔒

Authorization

Requires user scoped authorization via session token. See the 'Session Token Authentication' section in Enablement Services Authorization guide for reference.

The closeTradeline mutation is used to confirm that a user has opted to stop having a recurring bill reported to the credit bureau(s). Upon successful execution, it returns the tradeline object.

Below is an example of the closeTradeline mutation, detailing all available input fields and the fields included in the output.

mutation CloseTradeline  {
  closeTradeline(
    input: {
      id: ID!
    }
  ){
    tradeline {
      id
      merchant
      category
      isOpen
      isEligible
      paymentFrequency
      serviceAddress
      servicePhone
      leaseStartDate
      utilityTypes
      serviceAddressType
      createdAt
      updatedAt
      transactions(input: { first: Int!, after: Int! }) {
        totalCount
        edges {
          cursor
          node {
            id
            date
            value {
              amount
              currency
            }
          }
        }
      }
    }
  }
}

Input Attributes

AttributeDescription
idUnique tradeline identifier.

Output Attributes - Tradeline

AttributeDescription
idGlobal identifier for the tradeline.
merchantUser's email address
categoryUser's phone number
isOpenUser's name.
isEligibleWhether or not this tradeline is eligible to be reported to the credit bureaus.
attestationSee Attestation
paymentFrequencySee PaymentFrequency
serviceAddressAddress associated with the tradeline.
servicePhonePhone number associated with the tradeline.
leaseStartDateIf tradeline is that of RENT the lease start date should be provided.
utilityTypesThe different utility types covered by this tradeline. (Can be more than one) See UtilityType
serviceAddressTypeThe AddressType
createdAt
updatedAt
transactionsThe transactions for this particular tradeline