> ## Documentation Index
> Fetch the complete documentation index at: https://docs.advinservers.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Apply automatic payments to every service

> ### Overview

Makes every service follow the account's settings instead of its own, as changing them does. Each automatic payment a service set up on its own is stopped, so the default method pays for it while `enabled` is true and nothing does while it is false; one already ending at the end of its period is left to end. While `pays_from_credit` is false, each service still paying from account credit by its own setting has that turned off. Services that already follow the account are not touched.

A service that cannot be changed does not stop the others. The request then answers with an error naming each one, and those keep their own setting. Returns the account's setting.

### Permissions

Requires the account permission `billing.manage` (Manage billing).



## OpenAPI

````yaml https://console.advinservers.com/docs/openapi.json post /billing/autopay/sync
openapi: 3.1.2
info:
  title: API reference
  version: 1.0.0
  description: >-
    Use this API to manage your team's servers, networks, backups, and other
    resources.


    ## Authentication


    Create an API key under **API Keys** and send it as a bearer token with
    every request:


    ```

    Authorization: Bearer {YOUR_API_KEY}

    Accept: application/json

    ```


    Copy the key when you create it. It cannot be shown again. Revoking a key
    takes effect immediately.


    ## Permissions


    Give each key only the permissions it needs. Every endpoint lists the
    required permission.


    Permissions cover servers and other resources in the key's team.


    ## Team scope


    A key can access resources in the team selected when it was created. This
    includes servers,

    snapshots, backups, firewall groups, images, SSH keys, scripts, networks and
    addresses.

    Resources in other teams return `404 Not Found`. Create a separate key for
    each team.


    The key determines the team for every request. Legacy keys that had no team
    are assigned

    to the account's first owned team.


    ## Actions that need the panel


    API keys cannot do the following, even with every permission. Sign in to the
    panel in a

    browser to do them:


    - Create, edit or revoke API keys

    - Edit the IP groups that restrict API keys

    - End signed-in sessions

    - Change two-factor authentication

    - Change the account's email address

    - Accept or decline team invitations

    - Switch or leave a team


    This keeps a leaked key from widening its own access or locking you out of
    your account.


    ## Source IP restrictions


    A key can be restricted to one or more IP groups. Requests from other
    addresses are rejected.


    ## Requests and responses


    Each endpoint lists its path, query, header, and body parameters. Examples
    use fictional data.


    Single records use JSON objects. Collections use JSON arrays unless the
    endpoint supports pagination. Timestamps use ISO 8601 in UTC.


    Error responses include `message`. Validation errors also include an
    `errors` object for each field. Each endpoint lists its status codes.


    ## Audit log


    Every API request, including reads, is recorded in the account audit log
    with the key that made it.
servers:
  - url: https://console.advinservers.com/api/v1/client
security:
  - http: []
tags:
  - name: Account
    description: Billing contact details and account setup progress.
  - name: Account activity
    description: Actions performed in the current team by people and API keys.
  - name: Servers
    description: >-
      Order and list servers, read their state and resource use, open a console,
      and control power.
  - name: Server settings
    description: >-
      Rename a server, rebuild it, and change its hardware, media, resolvers and
      credentials.
  - name: Backups
    description: >-
      Scheduled server copies stored separately from the server. They cannot be
      deleted, and they are kept when the server is deleted.
  - name: Snapshots
    description: >-
      Take, restore and move server snapshots. Snapshots are kept in snapshot
      storage that the team buys by the GiB.
  - name: Firewall groups
    description: Reusable sets of firewall rules, and the servers they apply to.
  - name: IP groups
    description: Reusable address lists for the source or destination of firewall rules.
  - name: Server firewall
    description: >-
      Read default traffic policies and rules managed outside your firewall
      groups.
  - name: IP addresses
    description: Manage floating IPs and server address assignments.
  - name: Private networks
    description: Connect servers over a private network in the same location.
  - name: Reverse DNS
    description: Set the hostnames returned by IP address lookups.
  - name: Domain name
    description: Give a server its own domain name that points at one of its IP addresses.
  - name: DDoS protection
    description: Configure attack filtering for server addresses.
  - name: Bandwidth
    description: Buy extra bandwidth and share it between servers or location pools.
  - name: SSH keys
    description: Public keys the account can install on a server when it is built.
  - name: Setup scripts
    description: Scripts the account can run on a server when it is built.
  - name: ISO images
    description: ISO images you have downloaded, and the servers they are mounted on.
  - name: Server upgrades
    description: Change an existing server's plan.
  - name: Checkout
    description: Choose a payment method and pay for a purchase.
  - name: Invoices
    description: View and pay account invoices.
  - name: Billing
    description: Manage service renewals, payment methods and account credit.
  - name: Transfers
    description: Move resources between teams or transfer ownership.
  - name: Teams
    description: Manage the team assigned to your API key.
  - name: Team members
    description: Invite people and manage their team access.
  - name: Team roles
    description: Define the permissions granted to team members.
  - name: Team activity
    description: View actions performed in a team.
  - name: Support tickets
    description: >-
      Open, read, reply to and close support tickets. Tickets belong to the
      account holder and are not shared with team members.
paths:
  /billing/autopay/sync:
    post:
      tags:
        - Billing
      summary: Apply automatic payments to every service
      description: >-
        ### Overview


        Makes every service follow the account's settings instead of its own, as
        changing them does. Each automatic payment a service set up on its own
        is stopped, so the default method pays for it while `enabled` is true
        and nothing does while it is false; one already ending at the end of its
        period is left to end. While `pays_from_credit` is false, each service
        still paying from account credit by its own setting has that turned off.
        Services that already follow the account are not touched.


        A service that cannot be changed does not stop the others. The request
        then answers with an error naming each one, and those keep their own
        setting. Returns the account's setting.


        ### Permissions


        Requires the account permission `billing.manage` (Manage billing).
      operationId: client.billing.autopay.sync
      responses:
        '200':
          description: The record, as a JSON object. There is no envelope.
          content:
            application/json:
              schema:
                examples:
                  - enabled: true
                    pays_from_credit: true
                    credit_available: true
                    methods:
                      - uuid: b71cfb0d-abab-4721-9254-622be47149cb
                        uuid_short: Uuid short
                        type: Type
                        label: Label
                        brand: Brand
                        last_four: Last four
                        expires: Expires
                        is_default: true
                        service_ids:
                          - 1
                        created_at: '2026-09-14T16:42:09.000000Z'
                    cards_available: true
                    paypal_available: true
                allOf:
                  - $ref: '#/components/schemas/AccountAutopayData'
        '401':
          description: >-
            The key was missing, malformed, revoked, or belongs to an account
            that no longer exists.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    examples:
                      - Unauthenticated.
                required:
                  - message
        '403':
          description: >-
            Access denied. Check the key's team, permissions and allowed IP
            addresses. Some actions, such as managing API keys, require a
            browser session. The response message explains the reason.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    examples:
                      - >-
                        This API key is not allowed to do that in this team. It
                        needs the "snapshot.delete" permission.
                required:
                  - message
        '429':
          description: >-
            Too many requests. The `Retry-After` header says how many seconds to
            wait. Limits are per account, so several keys on one account share
            them.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    examples:
                      - Too Many Attempts.
                required:
                  - message
components:
  schemas:
    AccountAutopayData:
      type: object
      description: >-
        The account's saved payment methods, and whether every service and
        postpaid invoice is charged automatically.
      examples:
        - enabled: true
          pays_from_credit: true
          credit_available: true
          methods:
            - uuid: b71cfb0d-abab-4721-9254-622be47149cb
              uuid_short: Uuid short
              type: Type
              label: Label
              brand: Brand
              last_four: Last four
              expires: Expires
              is_default: true
              service_ids:
                - 1
              created_at: '2026-09-14T16:42:09.000000Z'
          cards_available: true
          paypal_available: true
      properties:
        enabled:
          type: boolean
          description: >-
            Whether every service and postpaid invoice is charged to the default
            method.
          examples:
            - true
        pays_from_credit:
          type: boolean
          description: >-
            Whether the account credit pays as much of every invoice as it can
            when it is due, with automatic payments on or off.
          examples:
            - true
        credit_available:
          type: boolean
          description: >-
            Whether that can be chosen: account credit is offered and the
            billing system can apply it to every service.
          examples:
            - true
        methods:
          type: array
          description: Saved cards and PayPal accounts, the default first.
          examples:
            - - uuid: b71cfb0d-abab-4721-9254-622be47149cb
                uuid_short: Uuid short
                type: Type
                label: Label
                brand: Brand
                last_four: Last four
                expires: Expires
                is_default: true
                service_ids:
                  - 1
                created_at: '2026-09-14T16:42:09.000000Z'
          items:
            $ref: '#/components/schemas/PaymentMethodData'
        cards_available:
          type: boolean
          description: Whether a card can be added, and whether a PayPal account can.
          examples:
            - true
        paypal_available:
          type: boolean
          description: The value of `paypal_available`.
          examples:
            - true
      required:
        - enabled
        - pays_from_credit
        - credit_available
        - methods
        - cards_available
        - paypal_available
      title: AccountAutopayData
    PaymentMethodData:
      type: object
      description: A saved card or PayPal account the panel charges for automatic payments.
      examples:
        - uuid: b71cfb0d-abab-4721-9254-622be47149cb
          uuid_short: Uuid short
          type: Type
          label: Label
          brand: Brand
          last_four: Last four
          expires: Expires
          is_default: true
          service_ids:
            - 1
          created_at: '2026-09-14T16:42:09.000000Z'
      properties:
        uuid:
          type: string
          description: The uuid UUID.
          examples:
            - b71cfb0d-abab-4721-9254-622be47149cb
        uuid_short:
          type: string
          description: The value of `uuid_short`.
          examples:
            - Uuid short
        type:
          type: string
          description: '`card` or `paypal`.'
          examples:
            - Type
        label:
          type: string
          description: >-
            How the method is named, such as "Visa ending 4242" or the PayPal
            account's email address.
          examples:
            - Label
        brand:
          type:
            - string
            - 'null'
          description: >-
            The card network as Stripe names it, such as `visa` or `amex`. Null
            for PayPal.
          examples:
            - Brand
        last_four:
          type:
            - string
            - 'null'
          description: A card's last four digits, null for PayPal.
          examples:
            - Last four
        expires:
          type:
            - string
            - 'null'
          description: A card's expiry as `MM/YY`, null for PayPal.
          examples:
            - Expires
        is_default:
          type: boolean
          description: >-
            Whether everything is charged to this method while automatic
            payments are on for the whole account.
          examples:
            - true
        service_ids:
          type: array
          description: The services whose renewals are charged to it on their own.
          examples:
            - - 1
          items:
            type: integer
        created_at:
          type: string
          description: The date and time for created at, in UTC.
          examples:
            - '2026-09-14T16:42:09.000000Z'
      required:
        - uuid
        - uuid_short
        - type
        - label
        - brand
        - last_four
        - expires
        - is_default
        - service_ids
        - created_at
      title: PaymentMethodData
  securitySchemes:
    http:
      type: http
      description: >-
        Your API key, sent as a bearer token. Create one in the control panel
        under API Keys, give it only the permissions the integration needs, and
        copy it when it is created. It cannot be shown again. Each key is
        restricted to one owned team. The key determines the team for every
        request.
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.