Mermaid Diagrams

email

WEBSITE

COMPANY_NAME

PRODUCT_NAME

Why is Documentation Extremely Important for Engineers

Check out the custom blocks that come with Archbee

docs.archbee.com/demo

Tech Specification

Docker cheatsheet

Launch checklist

Client Kickoff

Meeting Notes

Project Proposal

Project Retrospective

Post mortem

Investor Letter

Quarterly OKRs

Monthly Sales Recap

Marketing styleguides

User persona

Competitor watch

Social Media Policy

Marketing project

SEO Checklist

Retrieve Transaction Summary

Account Balance

Retrieve All Members.

Add Members

Edit License Levels

Retrieve Groups Assigned to an Account

Create Account Group

Unassign Account from Subscription

Unassign Account

Edit User Role

Retrieve Applicable Account Groups

Edit Account Group

Retrieve Invites

Invite to Account Group

Resend Invites

Accept Invites

Amend Invite

Retrieve All Subscriptions

Add Member to Subscription

Account Groups

Retrieve an accounts subscriptions

Initiate a subscription purchase

Complete an asynchronous subscription purchase

Update the renewal status of a subscription

Update Subscription Attributes

Add a voucher to a subscription

Change the subscription service.

/api/accounts/{accountReference}/subscriptions/{subscriptionReference}/moves

/api/accounts/{accountReference}/subscriptions/{subscriptionReference}/moves/{optionType}

Account Subscriptions

Trigger a forgotten password email

Link an account to a Yahoo Japan, Facebook, Google or Jahrain account

Verify an email address

Retrieve all accounts

Create account

Update password via email token

Authenticate via email

Authenticate via ClientUserId (Third Party)

Authenticate via an external SSO provider

Create an account via third-party

Retrieve account

Delete account

Update an account.

Trigger email verification

Replicate iTunes subscription within eSuite

Replicate Roku subscription within eSuite

Replicate Amazon subscription within eSuite

Replicate Google subscription within eSuite

Retrieve available external providers

Assign an existing subscription to a group

Accounts

Create address

Retrieve address

Delete address

Addresses

Retrieve analytics information

Analytics

Bulk add entitlements

Bulk Entitlements

Retrieve Bundles for the affiliate

Creates a Bundle for the affiliate

Retrieve a Bundle by reference

Allows a bundle to be deleted for an affiliate

Updates the properties of a bundle

Deletes a product from the specified bundle

Allows adding products to a pre defined bundle

Allows adding contract frequencies to be attached to a bundle

Updates the pricing for a product in a bundle

Deletes a contract from the specified bundle

Bundles

Create Cart

Retrieve Cart

Delete Cart

Update Cart

Create Line item

Delete Line item

Validate voucher against a cart

Add a voucher to a cart

Retrieve an accounts cart

Carts

Retrive all support logs

Create a support log

Retrieve a support log

Delete a support log

Edit a support log

Customer Support Log

Encodes an identifier from its composite pieces

Decodes an idenfier into a numeric value

Dev Tools

Get the client device policies

Insert a client device policy

Update a client device policy

Delete a client device policy

Get the account device policies

Insert an account device policy

Update an account device policy

Register a device

Updates a device

Deletes a device

Registers a slot

Check a slot

Releases a slot

Device Policy

Retrieve Entitlements

Create an entitlement

Validate access for an entitlement

Delete an entitlement

Entitlements

Retrieve a fulfilment for an account

Update a fulfilment

Create additional fulfilment payment

Retrieve all fulfilments for an account

Fulfilment

Creates a gift code and sends it to the recipient

Gifting

Create account and replicate iTunes subscriptions

Create account and replicate Roku subscriptions

Create account if it does not exist, if it exists authenticate account and create a subscription in the system for the service provided in the request object

Native Billing

Retrieve all offers

Retrieve offer

Retrieve all vouchers

Create a voucher code

Offers

Retrieve payment history

Initiate a purchase V2

Complete an asynchronous purchase

Update a payment instruction

Retrieves taxes for a given order

Refunds the payment

Orders

Create BACS wallet

Create SEPA wallet

Create Payment Card wallet

Retrieve payment accounts

Delete payment account

/api/payment-details/cards

Payment Details

Retrieve all payment instructions

Create a payment instruction

Retrieve a payment instruction

Retrieve summary of all payment instructions

Payment Instruction

Creates an endpoint available to inform the status of the platform.

Platform Status

Retrieve all product lists.

Create a product list

Retrieve a product list.

Delete a product list

Update a product list

Product Lists

Retrieve all products

/api/products

Create a price point

Update a price point

Retrieve a configured schedule

Create an issuing schedule

Update an issuing schedule

Delete a schedule

Retrieve a product

Update a product

Products

Initiate a service credit purchase

Service Credits

Return session status

Delete a session

Sessions

Retrieve subscription holidays

Create a subscription holiday

Retrieve a subscription holiday

Delete a subscription holiday

Update a subscription holiday

Subscription Holiday

Retrieve Subscription Services

Retrieves unique tokens for all active subscriptions configured for SwG, based on account reference

Retrieves taxes for a given service, using the configured tax calculation method for the affiliate

Subscriptions

API Reference

Mermaid Diagrams

Markdown flavored diagram language

Flowchart, sequences, Gantt, Class, ERD