Skip to content
Puurk Developers

Overview

Puurk API 1.0.0

Section titled “Puurk API 1.0.0”

The Puurk API lets you add payment plans to your product: create clients and payment plan offers, run checkout, and follow contracts and payments.

Build against the sandbox (https://apisandbox.puurk.com) first. It is a complete, isolated copy of production: Stripe runs in test mode (card 4242 4242 4242 4242), SMS and email are never delivered, and you provision your own private test organizations with POST /sandbox/organizations. Production (https://api.puurk.com) has the same endpoints, except the /sandbox/* ones.

Operations

Section titled “Operations”
POST
/activity
GET
/activity/{activityId}
DELETE
/activity/{activityId}
PATCH
/activity/{activityId}
GET
/organizations/{oid}/activity
GET
/organizations/{oid}/clients/{clientId}/activity
POST
/auth/token
GET
/auth/validate
GET
/auth/clients
POST
/auth/clients
DELETE
/auth/clients/{id}
PATCH
/auth/clients/{id}
POST
/auth/clients/{id}/rotate
GET
/checkout/services
POST
/checkout/quotes
POST
/checkout/sessions
GET
/checkout/sessions/{sessionId}
GET
/checkout/sessions/{id}/details
POST
/checkout/sessions/{id}/select-plan
POST
/checkout/sessions/{id}/prepare-payment
POST
/checkout/sessions/{id}/confirm
GET
/checkout/sessions/{id}/contract
GET
/leads
POST
/leads
GET
/leads/{leadId}
DELETE
/leads/{leadId}
PATCH
/leads/{leadId}
GET
/organizations/{oid}/leads
GET
/organizations/{oid}/leads/find
GET
/leads/{leadId}/photourl
POST
/contracts
GET
/contracts/{contractId}
DELETE
/contracts/{contractId}
PATCH
/contracts/{contractId}
GET
/organizations/{oid}/contracts
GET
/contracts/stats
POST
/contracts/stats
POST
/credits
GET
/credits/{id}
DELETE
/credits/{id}
PATCH
/credits/{id}
GET
/organizations/{oid}/credits
POST
/items-received
GET
/items-received/{itemId}
DELETE
/items-received/{itemId}
PATCH
/items-received/{itemId}
GET
/organizations/{oid}/items-received
GET
/onboarding/status
GET
/onboarding/progress
POST
/onboarding/progress
GET
/organizations
POST
/organizations
GET
/organizations/{oid}
DELETE
/organizations/{oid}
PATCH
/organizations/{oid}
GET
/organizations/{uid}/access
GET
/organizations/{oid}/logourl
GET
/organizations/{oid}/user/{uid}
POST
/organizations/{oid}/user/{uid}
DELETE
/organizations/{oid}/user/{uid}
PATCH
/organizations/{oid}/user/{uid}
GET
/organizations/{oid}/locations
POST
/organizations/{oid}/locations
GET
/organizations/{oid}/locations/{lid}
DELETE
/organizations/{oid}/locations/{lid}
PATCH
/organizations/{oid}/locations/{lid}
POST
/organizations/{oid}/user/{uid}/link
POST
/bulk/{uid}/organizations
POST
/bulk/{oid}/users
GET
/organizations/{oid}/onboarding
POST
/organizations/{oid}/onboarding
DELETE
/organizations/{oid}/onboarding
PATCH
/organizations/{oid}/onboarding
GET
/organizations/{oid}/legal
POST
/organizations/{oid}/legal
DELETE
/organizations/{oid}/legal
PATCH
/organizations/{oid}/legal
GET
/payments/{id}
GET
/offers/{offerId}/payments
GET
/contracts/{contractId}/payments
GET
/organizations/{oid}/merchant-account
POST
/organizations/{oid}/merchant-account/onboarding-link
POST
/checkout/prepare
POST
/checkout/prepare-setup
POST
/checkout/confirm-payment
POST
/checkout/verify-payment
POST
/offers/{offerId}/services
GET
/offers/stats
POST
/offers/stats
POST
/offers/assign-plan-numbers
GET
/offers/terms
GET
/offers
POST
/offers
GET
/offers/{offerId}
POST
/offers/{offerId}/credits
DELETE
/offers/{offerId}/credits/{creditId}
DELETE
/offers/{offerId}/services/{serviceId}
GET
/organizations/{oid}/offers
GET
/reports/deposit-summary
GET
/reports/deposit-detail
GET
/reports/monthly-ar
GET
/reports/payment-details
GET
/reports/services-sold-summary
GET
/reports/services-sold
POST
/services
GET
/services/{serviceId}
DELETE
/services/{serviceId}
PATCH
/services/{serviceId}
GET
/organizations/{oid}/services
GET
/users
POST
/users
GET
/users/{uid}
DELETE
/users/{uid}
PATCH
/users/{uid}
GET
/organizations/{oid}/users
GET
/users/{uid}/photourl
GET
/users/{uid}/communication-preferences
POST
/users/{uid}/communication-preferences
PATCH
/users/{uid}/communication-preferences
POST
/organizations/users/cleanup
GET
/webhooks
POST
/webhooks
DELETE
/webhooks/{id}
POST
/sandbox/reset
POST
/sandbox/organizations

Authentication

Section titled “Authentication”

firebase

Section titled “firebase”

Security scheme type: oauth2

Flow type: implicit

Authorization URL: https://provider.puurk.com

Scopes:

  • email - Access email address
  • openid - OpenID Connect
  • profile - Access user profile

service_account

Section titled “service_account”

Security scheme type: oauth2

Flow type: implicit

Authorization URL: https://provider.puurk.com

google_id_token

Section titled “google_id_token”

Security scheme type: oauth2

Flow type: implicit

Authorization URL: https://provider.puurk.com

service_token

Section titled “service_token”

Service token obtained via POST /auth/token. Provide client_id and client_secret to receive a Bearer JWT valid for 1 hour. Scopes are embedded in the JWT claims.

Security scheme type: http

Bearer format: JWT