1. Billing
HashPay API docs
  • Auth
    • Register a dashboard user and create their first organization.
      POST
    • Authenticate a dashboard user.
      POST
    • Rotate refresh token and issue a new access token.
      POST
    • Revoke a refresh token.
      POST
  • Organizations
    • List organizations visible to the current user.
      GET
    • Create an organization.
      POST
    • Get organization details.
      GET
    • Update organization profile and KYB fields.
      PATCH
    • Submit organization KYB for admin review.
      POST
  • Users
    • List organization members.
      GET
  • API Keys
    • List API keys.
      GET
    • Create an API key and return the secret once.
      POST
    • Revoke an API key.
      POST
  • Customers
    • List customers.
      GET
    • Create a customer.
      POST
    • Update a customer.
      PATCH
  • Wallets
    • List receiving wallets.
      GET
    • Register a public receiving wallet.
      POST
    • Archive a receiving wallet.
      POST
  • Invoices
    • List invoices.
    • Create an invoice.
    • Get an invoice.
    • Update draft invoice fields.
    • Cancel an invoice.
  • Checkout
    • Get public checkout session.
    • Submit transaction hash manually.
  • Payments
    • List invoice payment allocations.
  • Webhooks
    • List webhook endpoints.
    • Create webhook endpoint.
    • Update webhook endpoint.
    • Disable webhook endpoint.
    • List webhook deliveries.
    • Replay a webhook delivery.
  • Usage
    • Get current usage summary.
  • Billing
    • List available subscription plans.
      GET
    • Get active subscription.
      GET
    • Schedule a subscription plan change at period end.
      PATCH
    • Select a subscription plan and start a trial.
      POST
    • List HashPay platform invoices.
      GET
    • Get a HashPay platform invoice.
      GET
  • Analytics
    • Get merchant analytics summary.
    • Get merchant analytics chart data.
    • Get top customers by payment volume.
    • Get top wallets by payment volume.
  • Audit Logs
    • List audit logs.
  • Admin
    • List organizations for admin review.
    • Get organization detail for admin review.
    • Approve, reject, or request changes for merchant verification.
    • Get platform analytics summary for the admin overview.
    • Get platform analytics charts for the admin overview.
    • Get top merchants by processed volume for a period.
    • List invoice payments across organizations for investigation.
    • List audit logs across organizations.
    • Get platform billing receive-wallet configuration.
    • Assign the platform billing receive wallet.
    • List wallets belonging to the platform organization.
    • List platform invoices across organizations.
    • Get platform invoice detail with line items.
    • List credits for an organization.
    • Apply a billing credit to an organization.
    • List discounts for an organization.
    • Apply a billing discount to an organization.
    • List manual billing adjustments for an organization.
    • Create a manual billing adjustment for an organization.
    • Get platform operations status for the admin operations view.
    • List webhook deliveries across organizations.
    • List recent failed jobs for a BullMQ queue (read-only).
  • Schemas
    • LoginRequest
    • RegisterRequest
    • AuthSession
    • RefreshSessionRequest
    • LogoutRequest
    • Organization
    • OrganizationList
    • AdminOrganization
    • AdminReviewHistoryItem
    • AdminOrganizationDetail
    • AdminOrganizationList
    • UpdateOrganizationVerificationRequest
    • MembershipList
    • ApiKeyList
    • ApiKey
    • CreatedApiKey
    • Customer
    • CustomerList
    • Wallet
    • WalletList
    • CreateInvoiceRequest
    • Invoice
    • InvoiceStatus
    • InvoiceList
    • CheckoutSession
    • PaymentList
    • WebhookEndpoint
    • CreatedWebhookEndpoint
    • CreateWebhookEndpointRequest
    • UpdateWebhookEndpointRequest
    • WebhookEndpointList
    • WebhookDelivery
    • WebhookDeliveryList
    • UsageSummary
    • Subscription
    • SubscriptionOpenInvoice
    • ChangePlanRequest
    • SelectPlanRequest
    • PlanCatalog
    • Plan
    • PlatformInvoice
    • PlatformInvoiceList
    • AdminPlatformInvoice
    • AdminPlatformInvoiceLine
    • AdminPlatformInvoiceDetail
    • AdminPlatformInvoiceList
    • ApplyAdminCreditRequest
    • AdminCredit
    • AdminCreditList
    • ApplyAdminDiscountRequest
    • AdminDiscount
    • AdminDiscountList
    • CreateAdminManualAdjustmentRequest
    • AdminManualAdjustment
    • AdminManualAdjustmentList
    • AnalyticsSummary
    • MerchantAnalyticsSummary
    • MerchantAnalyticsCharts
    • MerchantVolumeSeriesPoint
    • MerchantInvoiceStatusBreakdownItem
    • TopCustomerList
    • TopWalletList
    • TopCustomer
    • TopWallet
    • TopOrganizationList
    • TopOrganization
    • AdminPaymentList
    • AdminPayment
    • AdminWebhookDeliveryList
    • AdminWebhookDelivery
    • AdminFailedQueueJobList
    • AdminFailedQueueJob
    • PlatformAnalyticsSummary
    • PlatformAnalyticsCharts
    • AdminOperationsStatus
    • OperationsProviderHealth
    • OperationsQueueDepth
    • OperationsWebhookBacklog
    • AuditLogList
    • AuditLog
  1. Billing

Select a subscription plan and start a trial.

POST
/organizations/{organizationId}/billing/subscription/select

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
API Key
Add parameter in header
X-HashPay-Key
Example:
X-HashPay-Key: ********************
or
Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200
application/json
Selected subscription with trial and open invoice details.
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.hashpay.me/v1/organizations//billing/subscription/select' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "plan": "starter"
}'
Response Response Example
{
    "id": "string",
    "plan": "string",
    "planName": "string",
    "status": "trialing",
    "currentPeriodStart": "2019-08-24T14:15:22.123Z",
    "currentPeriodEnd": "2019-08-24T14:15:22.123Z",
    "trialEndsAt": "2019-08-24T14:15:22.123Z",
    "pendingPlan": "string",
    "planChangeEffectiveAt": "2019-08-24T14:15:22.123Z",
    "openInvoice": {
        "id": "string",
        "status": "string",
        "total": "string",
        "currency": "string",
        "checkoutUrl": "string",
        "merchantInvoicePublicId": "string"
    }
}
Modified at 2026-08-13 12:54:46
Previous
Schedule a subscription plan change at period end.
Next
List HashPay platform invoices.
Built with