HashPay API docs
    • Auth
      • Register a dashboard user and create their first organization.
      • Authenticate a dashboard user.
      • Rotate refresh token and issue a new access token.
      • Revoke a refresh token.
    • Organizations
      • List organizations visible to the current user.
      • Create an organization.
      • Get organization details.
      • Update organization profile and KYB fields.
      • Submit organization KYB for admin review.
    • Users
      • List organization members.
    • API Keys
      • List API keys.
      • Create an API key and return the secret once.
      • Revoke an API key.
    • Customers
      • List customers.
      • Create a customer.
      • Update a customer.
    • Wallets
      • List receiving wallets.
      • Register a public receiving wallet.
      • Archive a receiving wallet.
    • 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 active subscription.
      • Schedule a subscription plan change at period end.
      • Select a subscription plan and start a trial.
      • List HashPay platform invoices.
      • Get a HashPay platform invoice.
    • 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

    Subscription

    {
    "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"
    }
}
    Built with