1. Policy
Olli
  • System
    • Confirm API connectivity
      GET
    • API health status
      GET
  • Programs
    • List programs available to the caller
      GET
    • Get program by ID
      GET
    • Get full detail on one program
      GET
  • Appetite
    • Search NAICS codes
      GET
    • Classifications for a NAICS code
      GET
    • Appetites for a classification
      GET
    • Full catalog for a classification
      GET
    • Appetite details (product-filtered)
      GET
  • Rate
    • Rate eligible programs for a risk
      POST
    • Sensitivity analysis across coverage options
      POST
  • Quote
    • List quote folios
      GET
    • Create a quote folio
      POST
    • View a quote folio (light — all programs)
      GET
    • Re-quote (new bindable, same group)
      POST
    • View one application (full — includes form schema + plan details)
      GET
    • Edit form_payload only
      POST
  • Bind
    • Bind quote requests
      POST
  • Policy
    • Get policy — full detail
      GET
    • Renewal payment
      POST
    • Cancel a policy
      POST
  • Schemas
    • Schemas
    • Response
    • Rates
  • Schemas
    • SuccessResponse
    • SuccessEnvelope
    • AttestationItem
    • ISO8601DateTime
    • ErrorResponse
    • ErrorEnvelope
    • BindQuotePayment
    • PingResponse
    • Pricing
    • Pagination
    • OffsetPagination
    • NaicsListResponse
    • PricingData
    • PricingNode
    • ValidationErrorEnvelope
    • BindQuoteItem
    • HealthResponse
    • CarrierRef
    • RateRequest
    • ProgramType
    • PagePagination
    • ClassificationListResponse
    • QuoteApplication
    • ProgramMarketing
    • PaginationWithPage
    • PolicyProgramNode
    • BindRequest
    • ProgramSummary
    • RateResult
    • CreateProgramTypeInput
    • PagePaginationWithMore
    • QuoteCarrierProgram
    • PlanDetails
    • ClassificationStub
    • PolicyCarrierNode
    • PolicyCustomer
    • ProgramEndorsement
    • MatrixRequest
    • UpdateProgramTypeInput
    • NaicsCode
    • QuoteFolio
    • ProgramNode
    • ClassificationFull
    • PolicyTermNode
    • PolicyBilling
    • ProgramOption
    • MatrixResult
    • ProgramListItem
    • Classification
    • CreateQuoteProgram
    • ProgramNodeFull
    • AppetiteItem
    • PolicySellerNode
    • PolicyDocumentAccess
    • ProgramTerm
    • Program
    • CreateClassificationInput
    • CreateQuoteRequest
    • CarrierNode
    • CatalogLimit
    • RateOption
    • PolicyCustomerNode
    • BoundPolicyReceipt
    • ProgramDetail
    • CreateProgramInput
    • UpdateClassificationInput
    • UpdateApplicationRequest
    • OptionItem
    • CatalogRule
    • AppliedOptions
    • PolicyInsuredItem
    • BindQuoteResult
    • ProductTypeEnum
    • UpdateProgramInput
    • AppetiteSummary
    • EndorsementItem
    • CatalogProductOption
    • PolicyLocationItem
    • BindSummary
    • RatingMethodEnum
    • AppetiteListItem
    • PaymentFrequency
    • CatalogEndorsement
    • PolicyEndorsementItem
    • BindResponseData
    • FormField
    • AppetiteCatalogEntry
    • PaymentOption
    • CatalogItem
    • PolicyCoverageItem
    • BindResponse
    • AppetiteDetail
    • DocumentItem
    • PolicyDocumentItem
    • BindResponseAllFailed
    • AppetiteRule
    • NoticeItem
    • NaicsWithClassificationsResponse
    • PolicyEventItem
    • ErrorResponse400
    • CreateAppetiteRuleInput
    • TermAndCondition
    • PolicyPaymentItem
    • ErrorResponseSimple
    • UpdateAppetiteRuleInput
    • FormSectionField
    • AppetiteListResponse
    • PolicyFull
    • AppetiteLimit
    • FormSection
    • CatalogResponse
    • AcceptedTerm
    • CreateAppetiteLimitInput
    • QuoteResponseProgramLight
    • Payment
    • UpdateAppetiteLimitInput
    • QuoteResponseProgramFull
    • PayBody
    • QuoteResponseLight
    • RecordedAcceptance
    • BillingConfig
    • PayResultToken
    • PayResultInvoiceAccount
    • PayResultCarrierCharge
    • PayResultFinalized
    • QuoteFolioCreated
    • CancelBody
    • CancelResult
    • CreateQuoteRatePayloadRequest
    • EditApplicationRequest
    • SystemPayload
    • FormPayload
  1. Policy

Renewal payment

POST
/v1/policy/{policyId}/pay
Renewal payment for an existing active policy. Initial payment happens at bind time — use POST /v1/bind with payment.token for first-time payment. This endpoint handles post-bind renewal cycles only: record required term acceptances for the new term and capture payment.
Dispatch matrix:
billing_modepayment.methodResponse mode
prepaid (default)credit_card, ach, affirmtoken — use clientSecret with Stripe Elements
invoicedanyinvoice_account — invoice posted immediately
anyany, with stripeChargeIdfinalized — agent/back-office path
anyaccount (carrier-tokenized)carrier_charge — forwarded to carrier

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200
application/json
Payment initiated or recorded.
Bodyapplication/json

🟠400ValidationError
🟠401Unauthorized
🟠401Unauthorized
🟠403Forbidden
🟠404NotFound
🟠404NotFound
🔴500InternalError
🔴500InternalError
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/v1/policy//pay' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "acceptedTerms": [
        {
            "termId": "a1b2c3d4-0000-0000-0000-000000000001",
            "termKey": "tos",
            "termVersion": "3.2",
            "acceptanceMethod": "checkbox",
            "acceptanceValue": null
        }
    ],
    "payment": {
        "method": "credit_card"
    }
}'
Response Response Example
200 - mode=token — Stripe prepaid (most common)
{
    "success": true,
    "data": {
        "mode": "token",
        "policyId": "f9e8d7c6-b5a4-3210-fedc-ba9876543210",
        "policyTermId": "e7f8g9h0-1234-5678-90ab-cdef01234567",
        "paymentIntentId": "pi-db-uuid-here",
        "clientSecret": "pi_xxx_secret_yyy",
        "stripePaymentIntentId": "pi_3PxxxxxxxxxxxQ",
        "recordedAcceptances": [
            {
                "termId": "a1b2c3d4-0000-0000-0000-000000000001",
                "termKey": "tos",
                "termVersion": "3.2",
                "acceptedAt": "2026-05-01T12:00:00Z"
            }
        ]
    }
}
Modified at 2026-05-05 23:27:59
Previous
Get policy — full detail
Next
Cancel a policy
Built with