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

Attribute	Description
id	Unique tradeline identifier.

Output Attributes - Tradeline

Attribute	Description
id	Global identifier for the tradeline.
merchant	User's email address
category	User's phone number
isOpen	User's name.
isEligible	Whether or not this tradeline is eligible to be reported to the credit bureaus.
attestation	See Attestation
paymentFrequency	See PaymentFrequency
serviceAddress	Address associated with the tradeline.
servicePhone	Phone number associated with the tradeline.
leaseStartDate	If tradeline is that of `RENT` the lease start date should be provided.
utilityTypes	The different utility types covered by this tradeline. (Can be more than one) See UtilityType
serviceAddressType	The AddressType
createdAt
updatedAt
transactions	The transactions for this particular tradeline