POST api/v1/render/credits

Details of either adding or using credits

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Authentication		AuthenticationModel	Required
Request		RenderCreditsRequestModel	Required

Request Formats

application/json, text/json

Sample:

{
  "Authentication": {
    "Id": "170200123 - sample only, user your ID",
    "Key": "467512342123 - sample only, user your Key"
  },
  "Request": {
    "Email": "larry@newmedia.com",
    "Bucket": "Bucket ID: 0 - Regular Credits, 1 - Tier 1 Credits, 2 - Tier 2 Credits, 3 - Tier 3 Credits, 4 - SaaS Tier 1 Credits, 5 - SaaS Tier 2 Credits, 6 - SaaS Tier 3 Credits",
    "UpdateType": "Credit, Debit, ",
    "Credits": "109",
    "Amount": "20.50 (include decimal places)",
    "PurchaseDate": "2025-12-04 06:57:36 (YYYY-MM-DD HH:MM:SS - UTC format)"
  }
}

application/xml, text/xml

Sample:

<RenderCreditsBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ApiModels">
  <Authentication xmlns:d2p1="http://schemas.datacontract.org/2004/07/Api.Models">
    <d2p1:Id>170200123 - sample only, user your ID</d2p1:Id>
    <d2p1:Key>467512342123 - sample only, user your Key</d2p1:Key>
  </Authentication>
  <Request>
    <Amount>20.50 (include decimal places)</Amount>
    <Bucket>Bucket ID: 0 - Regular Credits, 1 - Tier 1 Credits, 2 - Tier 2 Credits, 3 - Tier 3 Credits, 4 - SaaS Tier 1 Credits, 5 - SaaS Tier 2 Credits, 6 - SaaS Tier 3 Credits</Bucket>
    <Credits>109</Credits>
    <Email>larry@newmedia.com</Email>
    <PurchaseDate>2025-12-04 06:57:36 (YYYY-MM-DD HH:MM:SS - UTC format)</PurchaseDate>
    <UpdateType>Credit, Debit, </UpdateType>
  </Request>
</RenderCreditsBindingModel>

Response Information

Resource Description

ContactsOutgoingModel

Name	Description	Type	Additional information
Message		MessageModel	None.

Response Formats

application/json, text/json

Sample:

{
  "Message": {
    "Code": "(2 digit code reflecting result of request - 00 is good)",
    "Description": "(Message response in text depending upon request/result of request)"
  }
}

application/xml, text/xml

Sample:

<ContactsOutgoingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ApiModels">
  <Message xmlns:d2p1="http://schemas.datacontract.org/2004/07/Api.Models">
    <d2p1:Code>(2 digit code reflecting result of request - 00 is good)</d2p1:Code>
    <d2p1:Description>(Message response in text depending upon request/result of request)</d2p1:Description>
  </Message>
</ContactsOutgoingModel>