Credits

Get a credit purchase

One purchase, with whether it is paid, waiting for payment, not charged or expired, and how many credits it added.

CostWhat it doesKey scopes
FreeReads onlyargorant:read_counts
get/api/v1/credits/purchases/{purchase_id}

Request

  • Base URL: https://app.argorant.com
  • URL: https://app.argorant.com/api/v1/credits/purchases/{purchase_id}
  • Auth: HTTP bearer

Path parameters

purchase_idstring uuid required

The purchase id (the same as its quote id).

Headers

X-Request-Idstring

Your own id for this request, 8 to 64 letters, digits, dot, dash or underscore. Returned as X-Request-Id; one is made for you when you send none.

Response

OK

purchase_idstring uuid

Purchase id, the same as the quote id.

status'paid' | 'awaiting_payment' | 'processing' | 'not_charged' | 'expired'

paid: credits added. awaiting_payment: send checkout_url to the person who pays. processing: wait a minute. not_charged: the card was not charged. expired: the link ran out unpaid.

paid_withstring nullable

saved_card or payment_link.

cardstring nullable

The saved card that was charged, for example card ending 4242.

creditsinteger

Credits bought.

credits_addedinteger

Credits added to the account.

amount_centsinteger

Amount in cents.

currencystring

Currency.

checkout_urlstring uri nullable

Payment page for the person who pays.

messagestring

What happened, in one or two sentences.

saved_cardobject

Present when the saved card was not used, with used (false), code and reason.

replayedboolean

Present and true when this is the answer of an earlier call with the same quote.

Changes

No recorded changes to this operation across all 1 revision of this API.