--- title: Order a one time or a recurrence prepaid card by usage slug: amberflo-api/order-a-one-time-or-a-recurrence-prepaid-card-by-usage docTags: createdAt: 2024-11-07T15:10:16.975Z --- { "id": "HY_ps1VV0AgSoS5LZRh7W", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://app.amberflo.io/payments/pricing/amberflo/customer-prepaid/usage", "servers": [ { "url": "https://app.amberflo.io/payments/pricing/amberflo/customer-prepaid/usage" } ], "name": "Order a one time or a recurrence prepaid card by usage", "description": "", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "optional", "name": "body", "type": "object", "description": "", "customType": "payment.pricing.customer.CustomerPrepaidByUsage.in", "schema": [ { "name": "id", "kind": "optional", "type": "string", "example": "" }, { "name": "customerId", "kind": "optional", "type": "string", "example": "" }, { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "firstCardEndTimeSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "productId", "kind": "optional", "type": "string", "example": "" }, { "name": "prepaidOfferVersion", "kind": "optional", "type": "integer", "example": 0 }, { "name": "prepaidPrice", "kind": "optional", "type": "number", "example": "" }, { "name": "originalWorth", "kind": "optional", "type": "number", "example": "" }, { "name": "originalCurrency", "kind": "optional", "type": "string", "description": "Currency code in ISO 4217 format.", "example": "USD" }, { "name": "preferredPurchasingPrepaidCurrency", "kind": "optional", "type": "string", "description": "Currency code in ISO 4217 format.", "example": "USD" }, { "name": "recurrenceFrequency", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.BillingPeriod.in", "customType": "payment.pricing.BillingPeriod.in", "schema": [ { "name": "interval", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.BillingPeriodInterval.in", "customType": "payment.pricing.BillingPeriodInterval.in", "schema": [] }, { "name": "intervalsCount", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "externalPayment", "kind": "optional", "type": "boolean", "example": "" }, { "name": "relationId", "kind": "optional", "type": "string", "example": "" }, { "name": "createdTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "label", "kind": "optional", "type": "string", "example": "" }, { "name": "prepaidConditions", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidConditions.in", "customType": "payment.billing.prepaid_to_product.PrepaidConditions.in", "schema": [ { "name": "prepaidConditionsList", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCondition.in", "customType": "payment.billing.prepaid_to_product.PrepaidCondition.in[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.in", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.in", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "DimensionValueMapPrepaidCondition" }, { "name": "dimensionMapValue", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.in", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.in", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "ProductItemDimensionPrepaidCondition" }, { "name": "productItemId", "kind": "optional", "type": "string", "description": "The product item associated with the prepaid.", "example": "" }, { "name": "dimensions", "kind": "optional", "type": "map", "description": "The dimensions associated with the prepaid.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemPrepaidCondition.in", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemPrepaidCondition.in", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "ProductItemPrepaidCondition" }, { "name": "productItemId", "kind": "optional", "type": "string", "example": "" } ] } ] }, { "name": "prepaidConditionsHistory", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "commitmentId", "kind": "optional", "type": "string", "example": "" }, { "name": "orderId", "kind": "optional", "type": "string", "example": "" }, { "name": "orderItemId", "kind": "optional", "type": "string", "example": "" }, { "name": "senderPrepaidUri", "kind": "optional", "type": "string", "example": "" }, { "name": "customPriority", "kind": "optional", "type": "number", "example": "" }, { "name": "prepaidPriority", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.prepaid.PrepaidPriority.in", "customType": "payment.pricing.prepaid.PrepaidPriority.in", "schema": [] }, { "name": "startAtMidCycle", "kind": "optional", "type": "boolean", "example": "" }, { "name": "realTimePricing", "kind": "optional", "type": "boolean", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "customer_prepaid_by_usage" }, { "name": "purchaseType", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidPurchaseType.in", "customType": "payment.billing.prepaid_to_product.PrepaidPurchaseType.in", "schema": [] }, { "name": "prepaidUsage", "kind": "optional", "type": "number", "example": "" }, { "name": "prepaidFullPrice", "kind": "optional", "type": "number", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.customer.CustomerPrepaidByUsage.in", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "apiKey", "name": "X-API-KEY", "kind": "optional", "type": "apiKey", "in": "header" } ] }, "responses": [ { "statusCode": "200", "description": "Successful request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "payment.pricing.customer.detailed.DetailedCustomerPrepaid.out", "schema": [], "modelRef": "#/components/schemas/payment.pricing.customer.detailed.DetailedCustomerPrepaid.out", "complexItems": [ { "name": "object", "schema": [ { "name": "id", "kind": "optional", "type": "string", "example": "" }, { "name": "customerId", "kind": "optional", "type": "string", "example": "" }, { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "firstCardEndTimeSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "productId", "kind": "optional", "type": "string", "example": "" }, { "name": "prepaidOfferVersion", "kind": "optional", "type": "integer", "example": 0 }, { "name": "prepaidPrice", "kind": "optional", "type": "number", "example": "" }, { "name": "originalWorth", "kind": "optional", "type": "number", "example": "" }, { "name": "originalCurrency", "kind": "optional", "type": "string", "description": "Currency code in ISO 4217 format.", "example": "USD" }, { "name": "preferredPurchasingPrepaidCurrency", "kind": "optional", "type": "string", "description": "Currency code in ISO 4217 format.", "example": "USD" }, { "name": "recurrenceFrequency", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.BillingPeriod.out", "customType": "payment.pricing.BillingPeriod.out", "schema": [ { "name": "interval", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.BillingPeriodInterval.out", "customType": "payment.pricing.BillingPeriodInterval.out", "schema": [] }, { "name": "intervalsCount", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "externalPayment", "kind": "optional", "type": "boolean", "example": "" }, { "name": "relationId", "kind": "optional", "type": "string", "example": "" }, { "name": "createdTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "label", "kind": "optional", "type": "string", "example": "" }, { "name": "prepaidConditions", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidConditions.out", "customType": "payment.billing.prepaid_to_product.PrepaidConditions.out", "schema": [ { "name": "prepaidConditionsList", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCondition.out", "customType": "payment.billing.prepaid_to_product.PrepaidCondition.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "DimensionValueMapPrepaidCondition" }, { "name": "dimensionMapValue", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "ProductItemDimensionPrepaidCondition" }, { "name": "productItemId", "kind": "optional", "type": "string", "description": "The product item associated with the prepaid.", "example": "" }, { "name": "dimensions", "kind": "optional", "type": "map", "description": "The dimensions associated with the prepaid.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemPrepaidCondition.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "ProductItemPrepaidCondition" }, { "name": "productItemId", "kind": "optional", "type": "string", "example": "" } ] } ] }, { "name": "prepaidConditionsHistory", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "commitmentId", "kind": "optional", "type": "string", "example": "" }, { "name": "orderId", "kind": "optional", "type": "string", "example": "" }, { "name": "orderItemId", "kind": "optional", "type": "string", "example": "" }, { "name": "senderPrepaidUri", "kind": "optional", "type": "string", "example": "" }, { "name": "customPriority", "kind": "optional", "type": "number", "example": "" }, { "name": "prepaidPriority", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.prepaid.PrepaidPriority.out", "customType": "payment.pricing.prepaid.PrepaidPriority.out", "schema": [] }, { "name": "startAtMidCycle", "kind": "optional", "type": "boolean", "example": "" }, { "name": "realTimePricing", "kind": "optional", "type": "boolean", "example": "" }, { "name": "internalStatus", "kind": "optional", "type": "string", "example": "" }, { "name": "prepaidPaymentTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "paymentId", "kind": "optional", "type": "string", "example": "" }, { "name": "paymentStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.payment.PaymentStatus.out", "customType": "payment.payment.PaymentStatus.out", "schema": [] }, { "name": "firstInvoiceUri", "kind": "optional", "type": "string", "example": "" }, { "name": "modifiedTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "detailed_customer_prepaid_by_price" }, { "name": "purchaseType", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidPurchaseType.out", "customType": "payment.billing.prepaid_to_product.PrepaidPurchaseType.out", "schema": [] }, { "name": "actualPrepaidChargePrice", "kind": "optional", "type": "number", "description": "The actual absolute charge amount for the prepaid card, in base currency.", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.customer.detailed.DetailedCustomerPrepaidByPrice.out", "customType": "payment.pricing.customer.detailed.DetailedCustomerPrepaidByPrice.out" }, { "name": "object", "schema": [ { "name": "id", "kind": "optional", "type": "string", "example": "" }, { "name": "customerId", "kind": "optional", "type": "string", "example": "" }, { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "firstCardEndTimeSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "productId", "kind": "optional", "type": "string", "example": "" }, { "name": "prepaidOfferVersion", "kind": "optional", "type": "integer", "example": 0 }, { "name": "prepaidPrice", "kind": "optional", "type": "number", "example": "" }, { "name": "originalWorth", "kind": "optional", "type": "number", "example": "" }, { "name": "originalCurrency", "kind": "optional", "type": "string", "description": "Currency code in ISO 4217 format.", "example": "USD" }, { "name": "preferredPurchasingPrepaidCurrency", "kind": "optional", "type": "string", "description": "Currency code in ISO 4217 format.", "example": "USD" }, { "name": "recurrenceFrequency", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.BillingPeriod.out", "customType": "payment.pricing.BillingPeriod.out", "schema": [ { "name": "interval", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.BillingPeriodInterval.out", "customType": "payment.pricing.BillingPeriodInterval.out", "schema": [] }, { "name": "intervalsCount", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "externalPayment", "kind": "optional", "type": "boolean", "example": "" }, { "name": "relationId", "kind": "optional", "type": "string", "example": "" }, { "name": "createdTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "label", "kind": "optional", "type": "string", "example": "" }, { "name": "prepaidConditions", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidConditions.out", "customType": "payment.billing.prepaid_to_product.PrepaidConditions.out", "schema": [ { "name": "prepaidConditionsList", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCondition.out", "customType": "payment.billing.prepaid_to_product.PrepaidCondition.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "DimensionValueMapPrepaidCondition" }, { "name": "dimensionMapValue", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "ProductItemDimensionPrepaidCondition" }, { "name": "productItemId", "kind": "optional", "type": "string", "description": "The product item associated with the prepaid.", "example": "" }, { "name": "dimensions", "kind": "optional", "type": "map", "description": "The dimensions associated with the prepaid.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemPrepaidCondition.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "ProductItemPrepaidCondition" }, { "name": "productItemId", "kind": "optional", "type": "string", "example": "" } ] } ] }, { "name": "prepaidConditionsHistory", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "commitmentId", "kind": "optional", "type": "string", "example": "" }, { "name": "orderId", "kind": "optional", "type": "string", "example": "" }, { "name": "orderItemId", "kind": "optional", "type": "string", "example": "" }, { "name": "senderPrepaidUri", "kind": "optional", "type": "string", "example": "" }, { "name": "customPriority", "kind": "optional", "type": "number", "example": "" }, { "name": "prepaidPriority", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.prepaid.PrepaidPriority.out", "customType": "payment.pricing.prepaid.PrepaidPriority.out", "schema": [] }, { "name": "startAtMidCycle", "kind": "optional", "type": "boolean", "example": "" }, { "name": "realTimePricing", "kind": "optional", "type": "boolean", "example": "" }, { "name": "internalStatus", "kind": "optional", "type": "string", "example": "" }, { "name": "prepaidPaymentTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "paymentId", "kind": "optional", "type": "string", "example": "" }, { "name": "paymentStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.payment.PaymentStatus.out", "customType": "payment.payment.PaymentStatus.out", "schema": [] }, { "name": "firstInvoiceUri", "kind": "optional", "type": "string", "example": "" }, { "name": "modifiedTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "detailed_customer_prepaid_by_usage" }, { "name": "purchaseType", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidPurchaseType.out", "customType": "payment.billing.prepaid_to_product.PrepaidPurchaseType.out", "schema": [] }, { "name": "prepaidUsage", "kind": "optional", "type": "number", "example": "" }, { "name": "prepaidFullPrice", "kind": "optional", "type": "number", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.customer.detailed.DetailedCustomerPrepaidByUsage.out", "customType": "payment.pricing.customer.detailed.DetailedCustomerPrepaidByUsage.out" } ], "complexType": "oneOf", "isExpanded": true } ] } ], "examples": { "languages": [ { "id": "lHi2nOKyKou5U1zlvwkQP", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://app.amberflo.io/payments/pricing/amberflo/customer-prepaid/usage \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"type\": \"customer_prepaid_by_usage\"\n }'" }, { "id": "KYuWOzHZ1IQmf70vnBXw7", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"type\": \"customer_prepaid_by_usage\"\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://app.amberflo.io/payments/pricing/amberflo/customer-prepaid/usage\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "VBrzKgD0hyKMAXyApLJox", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://app.amberflo.io/payments/pricing/amberflo/customer-prepaid/usage\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"type\": \"customer_prepaid_by_usage\"\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "JS8oz7wY3BJzgFBkEvvCN", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://app.amberflo.io/payments/pricing/amberflo/customer-prepaid/usage\"\n\npayload = json.dumps({\n \"type\": \"customer_prepaid_by_usage\"\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "lHi2nOKyKou5U1zlvwkQP" }, "results": { "languages": [ { "id": "vMYi9AX7jyNtVAxt20tqY", "language": "200", "code": "// Successful request\n{}" } ], "selectedLanguageId": "vMYi9AX7jyNtVAxt20tqY" } }, "children": [ { "text": "" } ] }