creditGrantCreate

Grant promotional or adjustment usage credits. The creditGrantCreate mutation in Bunny's GraphQL API, with its input attributes, return type and an example request.

Scope required: billing:write

mutation creditGrantCreate ($subscriptionId: ID!, $kind: CreditGrantKind!, $amount: Float!, $currencyId: ID, $featureId: ID, $accessStart: ISO8601Date, $accessEnd: ISO8601Date, $priority: Int, $reason: String) {
  creditGrantCreate (subscriptionId: $subscriptionId, kind: $kind, amount: $amount, currencyId: $currencyId, featureId: $featureId, accessStart: $accessStart, accessEnd: $accessEnd, priority: $priority, reason: $reason) {
      creditGrant {
        accessEnd
        accessStart
        accountId
        amount
        costBasisPerCredit
        createdAt
        creditBalanceId
        currencyId
        denomination
        featureId
        id
        invoiceItemId
        priority
        quoteChargeId
        reason
        remaining
        subscriptionChargeId
        subscriptionId
        voidReason
        voidedAt
      }
  }
}

ArgumentsLink to Arguments section

{
  "subscriptionId": "456123",
  "kind": "CreditGrantKind",
  "amount": "1.00",
  "currencyId": "456123",
  "featureId": "456123",
  "accessStart": "2022-06-01",
  "accessEnd": "2022-06-01",
  "priority": 123,
  "reason": ""
}
Name Type Description
subscriptionId ID  
kind CreditGrantKind  
amount Float  
currencyId ID  
featureId ID  
accessStart ISO8601Date  
accessEnd ISO8601Date  
priority Int  
reason String  

ResponseLink to Response section

Name Type Description
creditGrant CreditGrant