Payments

Create Company Payment

post/api/company-payment/

Request

  • Base URL
    https://api.avete.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Request body

company_idinteger required

ID of the company making the payment

plan_idinteger required

ID of the plan selected

amountinteger required

Total amount billed in yen

status'paid' | 'pending' | 'failed' | 'cancelled' | 'expired' | 'invoiced' required
stripecustomeridstring required

Stripe Customer ID

stripesubscriptionidstring required

Stripe Subscription ID

invoice_urlstring nullable

Stripe-hosted invoice URL

stripe_invoice_idstring nullable

Stripe invoice ID

payment_method'stripe' | 'bank_transfer' | 'external_api'

How this payment is settled

external_providerstring nullable

External API provider when payment_method=external_api

billing_period_startstring date-time nullable
billing_period_endstring date-time nullable
day_rateinteger nullable
usage_daysinteger nullable
notesstring nullable

Response

Successful Response

idinteger required
company_idinteger required
plan_idinteger required
amountinteger required
status'paid' | 'pending' | 'failed' | 'cancelled' | 'expired' | 'invoiced' required
stripecustomeridstring required
stripesubscriptionidstring required
invoice_urlstring nullable
stripe_invoice_idstring nullable
payment_method'stripe' | 'bank_transfer' | 'external_api' nullable
external_providerstring nullable
billing_period_startstring date-time nullable
billing_period_endstring date-time nullable
day_rateinteger nullable
usage_daysinteger nullable
notesstring nullable
created_datestring date-time required
updated_datestring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.