How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Soracom

Soracom Payment API

- [Coupon codes](/en/guides/accounting/payment/register-coupon/)- [Usage charges (billing details)](/en/guides/accounting/check-usage/)- [Payment methods](/en/guides/accounting/payment/)- [Long term discounts](/en/docs/air/volume-discount/)

Documentation Provider Profile APIs.io OpenAPI GitHub

Soracom Payment API is one of 45 APIs that Soracom publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include Payment. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 4 JSON Schemas.

This API exposes 11 operations across 10 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version 20250903-043502.

Requests are made against 2 base URLs: https://api.soracom.io/v1, https://g.api.soracom.io/v1.

11 operations 10 paths 12 schemas 7 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
20250903-043502
Base URL
https://api.soracom.io/v1
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Soracom Payment API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-Soracom-API-Key (api_key). An API key is passed in the header as X-Soracom-Token (api_token).

  • api_key — API key for authentication. Obtain this from the Soracom User Console or via the Auth API. Required in combination with an API token for all authenticated requ…
  • api_token — API token for authentication. This token has an expiration time and must be refreshed periodically. Required in combination with an API key for all authenticat…

Paths & Operations 11

Across 10 paths, the API surfaces 11 operations — 7 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Payment 11

- [Coupon codes](/en/guides/accounting/payment/register-coupon/) - [Usage charges (billing details)](/en/guides/accounting/check-usage/) - [Payment methods](/en/guides/accounting/…

GET
/coupons
List coupons.
listCoupons → 200
POST
/coupons/{coupon_code}/register
Register Coupon
registerCoupon 1 param → 200400
GET
/payment_history/transactions/{payment_transaction_id}
Get payment transaction result.
getPaymentTransaction 1 param → 200400404
GET
/payment_methods/current
Get current payment method information.
getPaymentMethod → 200404
POST
/payment_methods/current/activate
Activate current payment method
activatePaymentMethod → 200404
GET
/payment_statements
List payment statements
listPaymentStatements → 200
POST
/payment_statements/{payment_statement_id}/export
Export payment statement
exportPaymentStatement 2 params → 200400
GET
/payment_statements/payer_information
Export payer information
getPayerInformation → 200400
POST
/payment_statements/payer_information
Register payer information
registerPayerInformation body → 201400
GET
/volume_discounts
List long term discounts
listVolumeDiscounts → 200
GET
/volume_discounts/{contract_id}
Get long term discount
getVolumeDiscount 1 param → 200400

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are GetVolumeDiscountResponse (12 properties), PaymentStatementResponse (9 properties), PaymentAmount (9 properties), CouponResponse (7 properties). Each schema is shown below with its type and property counts.

GetPaymentMethodResult
object
5 properties
PaymentStatementResponse
object
9 properties
ListPaymentStatementResponse
object
1 property
GetPaymentTransactionResult
object
5 properties
RegisterPayerInformationModel
object
3 properties
PaymentAmount
object
Payment amount.
9 properties
ListVolumeDiscountResponse
object
1 property
PaymentDescription
object
Payment description.
2 properties
CouponResponse
object
7 properties
ListCouponResponse
object
1 property
FileExportResponse
object
3 properties
GetVolumeDiscountResponse
object
12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

soracom-payment-api-openapi.yml Raw ↑

Other APIs Soracom publishes across the network.

Soracom SIM Management API
AE Profile APIs.io
Soracom Group Configuration API
AE Profile APIs.io
Soracom Billing API
AE Profile APIs.io
Soracom Stats and Diagnostics API
AE Profile APIs.io
Soracom Auth and Access Management API
AE Profile APIs.io
Soracom Lagoon API
AE Profile APIs.io
Soracom Cloud Camera Services API
AE Profile APIs.io
Soracom Batch API
AE Profile APIs.io
Soracom Analysis API
AE Profile APIs.io
Soracom API Sandbox: Coupon API
AE Profile APIs.io
Soracom API Sandbox: Operator API
AE Profile APIs.io
Soracom API Sandbox: Order API
AE Profile APIs.io
#Payment
← Back to S APIs
API Details
ID
soracom:soracom-payment-api
Base URL
https://api.soracom.io/v1
Docs
https://users.soracom.io/ja-jp/tools/api/reference/#/Sim
Provider
Soracom
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=soracom-payment-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/soracom-payment-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Soracom Payment API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.