Manage Contract

When you sign up for a OneAtlas account, your user will be assigned to a contract. This contract will contain a private and dedicated workspace for yourself and any other users within the same contract.

There are currently two types of contact:

Premium: standard access based on a pre-paid service
Free Trial: this contract will contain a “trial-plan” subscription which allows a maximum of three datasets. You can pick these from our OneAtlas Portal when you sign up. This will give you access to stream in these areas, get access to our Basemap layer, WorldDem elevation layer and 2 free Change Detection sample reports.

This guide will walk you through managing your subscription, revoking your subscription and checking your payments.

Retrieve your Account Information


API Endpoint	/api/v1/me
REST verb	GET
Authentication	Bearer Token
API Reference	API orders and manage contract

The endpoint /me will retrieve all information related to your profile:

curl -X GET https://data.api.oneatlas.airbus.com/api/v1/me \
  -H 'Authorization: Bearer <access_token>'

     
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://data.api.oneatlas.airbus.com/api/v1/me");
xhr.setRequestHeader("Authorization", "Bearer <access_token>");

xhr.send(data);

     
import requests

url = "https://data.api.oneatlas.airbus.com/api/v1/me"

headers = {
    'Authorization': "Bearer <access_token>",
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

You will receive the following:

{
    "_links": {
        "self": {
            "href": "https://data.api.oneatlas.airbus.com/api/v1/me"
        },
        "licenses": {
            "href": "https://data.api.oneatlas.airbus.com/api/v1/licenseAgreements"
        }
    },
    "id": "bf3d937a-e846-446a-e5b6-0a26227b892f",
    "status": "created",
    "createdAt": "2018-04-30T08:51:43.393720+00:00",
    "roles": [
        "user",
    ],
    "contract": {
        "_links": {
            "self": {
                "href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/8b273bd7-5626-4ef3-80cf-c4fc33191083"
            },
            "orders": {
                "href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/8b273bd7-5626-4ef3-80cf-c4fc33191083/orders"
            },
            "payments": {
                "href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/8b273bd7-5626-4ef3-80cf-c4fc33191083/payments"
            },
            "subscriptions": {
                "href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/8b273bd7-5626-4ef3-80cf-c4fc33191083/subscriptions"
            },
             "deliveries": {
                "href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/8b273bd7-5626-4ef3-80cf-c4fc33191083/deliveries"
            },
            "reports": {
                "href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/8b273bd7-5626-4ef3-80cf-c4fc33191083/reports"
            }
        },
        "id": "8b273bd7-5626-4ef3-80cf-c4fc33191083",
        "status": "created",
        "createdAt": "2018-06-11T09:23:01.868510+00:00",
        "offers": [
            "order.product",
            "order.subscription.change-detection",
            "order.subscription.streaming"
        ],
        "amountUnit": "EUR",
        "kind": "contract.change-detection",
        "name": "airbus guide",
        "balance": 1341,
        "workspaceId": "148eebbd-a9b9-4cf6-97d3-87237901a7"
    }
}

This endpoint gives you access to the licence, information about your account such as ID and creation date, your contracts, orders, payments and subscriptions. Lets take a look at some of the above links example in more detail.

Get User Roles

You can quickly list your user roles by using the endpoint /me/services.

curl -X GET https://data.api.oneatlas.airbus.com/api/v1/me/services \
  -H 'Authorization: Bearer <access_token>'

     
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://data.api.oneatlas.airbus.com/api/v1/me/services");
xhr.setRequestHeader("Authorization", "Bearer <access_token>");
xhr.setRequestHeader("Content-Type", "application/json");

xhr.send(data);

     
import requests

url = "https://data.api.oneatlas.airbus.com/api/v1/me/services"

headers = {
    'Authorization': "Bearer <access_token>",
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

Example return:

{
    "oneatlas-data": true,
    "change-detection": false,
    "geostore-premier": true,
    "verde": false,
    "ocean-finder": false,
    "earth-monitor": true,
    "analytics-toolbox": true,
    "pfneo-3d": false,
    "tasking": false
}

Get Contract Information

This API is used to retrieve details of a contract.


API Endpoint	/api/v1/contracts/{contractId}
REST verb	GET
Authentication	Bearer Token
API Reference	API orders and manage contract.

Tag	Description
id	unique contract identification object relating to the contract.
_links	provides a direct link to the contract itself.
balance	your remaining balance in your account.
workspaceId	id of the workspace.

Example to retrieve information regarding a contract:

curl -X GET \
  https://data.api.oneatlas.airbus.com/api/v1/contracts/{contract_id} \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Content-Type: application/json'

     
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://data.api.oneatlas.airbus.com/api/v1/contracts/{contract_id}");
xhr.setRequestHeader("Authorization", "Bearer <access_token>");
xhr.setRequestHeader("Content-Type", "application/json");

xhr.send(data);

     
import requests

url = "https://data.api.oneatlas.airbus.com/api/v1/contracts/{contract_id}"

headers = {
    'Authorization': "Bearer <access_token>",
    'Content-Type': "application/json",
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

As a return we get all the details relating to the contract:

{
    "_links": {
        "self": {
            "href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/ff731b8d-5637-40aa-89ad-daa736613714"
        },
        "orders": {
            "href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/ff731b8d-5637-40aa-89ad-daa736613714/orders"
        },
        "payments": {
            "href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/ff731b8d-5637-40aa-89ad-daa736613714/payments"
        },
        "subscriptions": {
            "href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/ff731b8d-5637-40aa-89ad-daa736613714/subscriptions"
        },
        "deliveries": {
            "href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/ff731b8d-5637-40aa-89ad-daa736613714/deliveries"
        },
        "reports": {
            "href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/ff731b8d-5637-40aa-89ad-daa736613714/reports"
        }
    },
    "id": "xxxxxx-yyyyyy-zzzzzz-vvvvvv",
    "status": "created",
    "createdAt": "2018-06-29T09:46:15.309000+00:00",
    "offers": [
        "order.analytics-toolbox.archive",
        "order.earth-monitor.analytics",
        "order.data.gb.product"
    ],
    "amountUnit": "EUR",
    "kind": "contract.change-detection",
    "name": "Airbus_DEMO",
    "balance": 28203,
    "workspaceId": "1898ea7e-d3ac-4f74-b374-0f1496"
}

The status of the contract can either be pending, created, error or active.

Get All Subscriptions for a Given Contract

This API is used to retrieve all subscriptions within a contract.


API Endpoint	/api/v1/contracts/{contractId}/subscriptions
REST verb	GET
Authentication	Bearer Token
API Reference	API orders and manage contract.
API Get request	(Use the access token retrieved during authentication step).

Path parameters	Required	Description
contractId	yes	String ; contractId

Query parameters	Required	Description
page	no	number >= 1 ; Page number, defaults to ‘1’
itemsPerPage	no	number >= 1
type	no	string ; `view` `change-detection`

curl -X GET \
  https://data.api.oneatlas.airbus.com/api/v1/contracts/{contract_id}/subscriptions \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Content-Type: application/json'

     
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://data.api.oneatlas.airbus.com/api/v1/contracts/{contract_id}/subscriptions");
xhr.setRequestHeader("Authorization", "Bearer <access_token>");
xhr.setRequestHeader("Content-Type", "application/json");

xhr.send(data);

     
import requests

url = "https://data.api.oneatlas.airbus.com/api/v1/contracts/{contract_id}/subscriptions"

headers = {
    'Authorization': "Bearer <access_token>",
    'Content-Type': "application/json",
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

Here you can see an example of the data returned:

{
    "startIndex": 0,
    "totalResults": 5,
    "itemsPerPage": 10,
    "items": [
        {
            "_links": {
                "self": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/subscriptions/0b9da7d1-5b21-4532-84db-fd8b399ec47e"
                },
                 "contract": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/ff731b8d-5637-40aa-89ad-daa736613714"
                },
                 "reports": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/subscriptions/0b9da7d1-5b21-4532-84db-fd8b399ec47e/reports"
                },
                 "deliveries": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/deliveries?subscriptionId=0b9da7d1-5b21-4532-84db-fd8b399ec47e"
                },
                "payments": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/payments?subscriptionId=0b9da7d1-5b21-4532-84db-fd8b399ec47e"
                },
                 "orders": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/orders?subscriptionId=0b9da7d1-5b21-4532-84db-fd8b399ec47e"
                }
            },
            "id": "0b9da7d1-5b21-4532-84db-fd8b399ec47e",
            "status": "active",
            "startedAt": "2019-02-07T16:47:56.272827+00:00",
            "endedAt": "2019-12-01T00:00:00+00:00",
            "service": "data",
            "isAmountEstimated": "true",
            "kind": "subscription.oneatlas",
            "title": "OneAtlas",
            "workspaceId": "1898ea7e-d3ac-4f74-b374-0f1496388b00",
            "offers": []
        },
        {
            "_links": {
                "self": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/subscriptions/8fe89b39-9745-40b1-9a1f-5ce98aba2b13"
                },
                "contract": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/ff731b8d-5637-40aa-89ad-daa736613714"
                },
                "reports": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/subscriptions/0b9da7d1-5b21-4532-84db-fd8b399ec47e/reports"
                },
                "deliveries": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/deliveries?subscriptionId=0b9da7d1-5b21-4532-84db-fd8b399ec47e"
                },    
                "payments": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/subscriptions/8fe89b39-9745-40b1-9a1f-5ce98aba2b13/payments"
                },
                "orders": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/orders?subscriptionId=0b9da7d1-5b21-4532-84db-fd8b399ec47e"
                },
                "packs": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/subscriptions/0b9da7d1-5b21-4532-84db-fd8b399ec47e/packs"
                }
            },
            "id": "8fe8db39-9745-40b1-9a1f-5cf98ab2b13",
            "status": "active",
            "startedAt": "2019-01-03T08:13:54.780700+00:00",
            "endedAt": "2019-07-03T08:13:54.780700+00:00",
            "service": "data",
            "isAmountEstimated": "false",
            "title": "custom",
            "kind": "subscription.data.premium",
            "offers": [
                "order.data.gb.product"
            ]
      }

Let’s look at some of the parameters above in more detail:

Tag	Description
id	Unique subscription identification object relating to the subscription.
status	Status of the subscription.
startedAt	Start date of the subscription.
endedAt	End date of the subscription.
service	Corresponds to the OneAtlas related service.
isAmountEstimated	Indicates whether amount is estimated or not.
title	Custom title of the subscription.
kind	Kind of the subscription, can be `subscription.data.premium`, `subscription.oneatlas`…
offers	Offers, can be `order.data.gb.product` for example.

Premium users will also have a OneAtlas subscription alongside their subscription plan. You can see this in the example above. This is a generic subscription given to all OneAtlas Data premium users. This gives you access to OneAtlas Data services, without this you will not have permission to use the full services.

Get Information for a Specific Subscription

This API is used to retrieve a subscription related to a contract.


API Endpoint	/api/v1/contracts/{contractId}/subscriptions/{subscriptionId}
REST verb	GET
Authentication	Bearer Token
API Reference	API orders and manage contract.
API Get request	(Use the access token retrieved during authentication step).

Path parameters	Required	Description
contractId	yes	String ; contract Id
subscriptionId	yes	String ; subscription Id

Here is an example to retrieve information on a subscription within a contract:

curl -X GET \
  https://data.api.oneatlas.airbus.com/api/v1/contracts/{contractId}/subscriptions/{subscriptionId} \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Content-Type: application/json'

     
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://data.api.oneatlas.airbus.com/api/v1/contracts/{contractId}/subscriptions/{subscriptionId}");
xhr.setRequestHeader("Authorization", "Bearer");
xhr.setRequestHeader("Content-Type", "application/json");

xhr.send(data);

     
import requests

url = "https://data.api.oneatlas.airbus.com/api/v1/contracts/{contractId}/subscriptions/{subscriptionId}"

headers = {
    'Authorization': "Bearer <access_token>",
    'Content-Type': "application/json",
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

For information related to your streaming plans please see the table below:

Streaming plan name	Description
discover	Includes the right to stream 1 GB
starter	Includes the right to stream 4 GB
standard	Includes the right to stream 10 GB
advanced	Includes the right to stream 30 GB

Revoke a Subscription


API Endpoint	/api/v1/subscriptions/{subscription_id}/revoke
REST verb	GET
Authentication	Bearer Token
API Reference	Revoke a subscription.
API Get request	(Use the access token retrieved during authentication step).

Revoking is based on how many “runs” there are within your subscription. A quarterly subscription contains a max/min of 2 runs (2 runs * 3 months = 6 months). A monthly subscription can contain between a minimum of 2 runs (2 months) and a maximum of 6 runs (6 months). It is possible to revoke during a run, but the subscription will only stop at the end of the period.

You can revoke a subscription by passing the subscriptionId into the endpoint /revoke:

curl -X GET \
  https://data.api.oneatlas.airbus.com/api/v1/{subscriptionId}/revoke \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json' \

     
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://data.api.oneatlas.airbus.com/api/v1/{subscriptionId}/revoke");
xhr.setRequestHeader("Authorization", "Bearer <access_token>");
xhr.setRequestHeader("Cache-Control", "no-cache");
xhr.setRequestHeader("Content-Type", "application/json");

xhr.send(data);

     
import requests

url = "https://data.api.oneatlas.airbus.com/api/v1/{subscriptionId}/revoke"

headers = {
    'Authorization': "Bearer",
    'Cache-Control': "no-cache",
    'Content-Type': "application/json",
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

Once you have revoked your subscription, you will receive your newly updated subscription information with a new end date.

Refunding Your Account

If you revoke a monthly change detection subscription, you will be refunded for the months you have not used. For example, if you have a 4 month subscription starting in August and you decide to revoke on August 20th, you will be refunded the period September till November.
A quarterly subscription has a min/max of 2 runs (6 months). Therefore if you revoke during a quarterly subscription, you will be refunded for the 3 month quarter which you have not used. For example, if you have a quarterly subscription from January until June (6 months) and you revoke in March, you will be refunded the period April till June.
If your subscription has not started it will be instantly revoked and a full refund will be received.

Get Payments for a Contract


API Endpoint	/api/v1/contracts/{contractId}/payments
REST verb	GET
Authentication	Bearer Token
API Reference	API orders and manage contract.
API Get request	(Use the access token retrieved during authentication step).

Parameters	Required	Description
contractId	yes	String ; contract id
paymentId	yes	String ; payment id

Query parameters	Required	Description
page	no	number >= 1 ; Page number, defaults to ‘1’
itemsPerPage	no	number >= 1

You can use the following request to check your payments relating to your contract:

curl -X GET \
  'https://data.api.oneatlas.airbus.com/api/v1/contracts/{contractId}/payments' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Content-Type: application/json' \

     
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://data.api.oneatlas.airbus.com/api/v1/contracts/{contractId}/payments");
xhr.setRequestHeader("Authorization", "Bearer <access_token>");
xhr.setRequestHeader("Content-Type", "application/json");

xhr.send(data);

     
import requests

url = "https://data.api.oneatlas.airbus.com/api/v1/contracts/{contractId}/payments"

headers = {
    'Authorization': "Bearer <access_token>",
    'Content-Type': "application/json",
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

This will return:

{
    "startIndex": 0,
    "totalResults": 494,
    "itemsPerPage": 10,
    "items": [
        {
            "_links": {
                "self": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/payments/5c247131-1b8e-4cba-a373-8e54089c6210"
                },
                "contract": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/ff731b8d-5637-40aa-89ad-daa736613714"
                },
                "order": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/orders/7ea032fe-428a-4ba1-92d9-533898c516a0"
                },
                "subscription": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/subscriptions/8fe89b39-9745-40b1-9a1f-5ce98aba2b13"
                },
                "parentPayment": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/payments/88dc3fb6-0fe3-4959-b26b-481fbd3475c5"
                }
            },
            "id": "5c247131-1b8e-4cba-a373-8e54089c6210",
            "amount": 1056,
            "type": "consumption",
            "createdAt": "2019-08-01T05:45:21.330984+00:00",
            "createdBy": "service_account",
            "description": "Consumption Update : Adjustment of the real weight of the product order.",
            "service": "data",
            "amountUnit": "kB"
        },
        {
            "_links": {
                "self": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/payments/88dc3fb6-0fe3-4959-b26b-481fbd3475c5"
                },
                "contract": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/ff731b8d-5637-40aa-89ad-daa736613714"
                },
                "order": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/orders/7ea032fe-428a-4ba1-92d9-533898c516a0"
                },
                "subscription": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/subscriptions/8fe89b39-9745-40b1-9a1f-5ce98aba2b13"
                }
            },
            "id": "88dc3fb6-0fe3-4959-b26b-481fbd3475c5",
            "amount": 10892,
            "type": "consumption",
            "createdAt": "2019-08-01T05:43:10.318578+00:00",
            "createdBy": "b9bcb744-416f-44f5-5cda-9cf4832fb352",
            "description": "Consumption added : Product GB order",
            "service": "data",
            "amountUnit": "kB"
        },

Get Payments for a Subscription


API Endpoint	/api/v1/subscriptions/{subscriptionId}/payments
REST verb	GET
Authentication	Bearer Token
API Reference	API orders and manage contract.
API Get request	(Use the access token retrieved during authentication step).

Parameters	Required	Description
contractId	yes	String ; contract id
subscriptionId	yes	String ; payment id

Query parameters	Required	Description
page	no	number >= 1 ; Page number, defaults to ‘1’
itemsPerPage	no	number >= 1

You can use the following request to retrieve your payment information relating to a subscription:

curl -X GET \
  'https://data.api.oneatlas.airbus.com/api/v1/subscriptions/{subscriptionId}/payments' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Content-Type: application/json' \

     
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://data.api.oneatlas.airbus.com/api/v1/subscriptions/{subscriptionId}/payments");
xhr.setRequestHeader("Authorization", "Bearer <access_token>");
xhr.setRequestHeader("Content-Type", "application/json");

xhr.send(data);

     
import requests

url = "https://data.api.oneatlas.airbus.com/api/v1/subscriptions/{subscriptionId}/payments"

headers = {
    'Authorization': "Bearer <access_token>",
    'Content-Type': "application/json",
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

This will return:

{
    "startIndex": 0,
    "totalResults": 7,
    "itemsPerPage": 10,
    "items": [
        {
            "_links": {
                "self": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/payments/d5b3e5a6-4f71-4264-9907-2bbaefbd4ee5"
                },
                "contract": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/ff731b8d-5637-40aa-89ad-daa736613714"
                },
                "order": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/orders/8adf753b-97f5-400a-9b41-beadaa2b3729"
                },
                "subscription": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/subscriptions/afa8e48d-9a0a-4197-9488-a1083ccc3b29"
                }
            },
            "id": "d5b3e5a6-4f71-4264-9907-2bbaefbd4ee5",
            "amount": 226,
            "type": "payment",
            "createdAt": "2019-07-17T10:48:24.589878+00:00",
            "createdBy": "f28dd764-8000-475a-c583-764eed121e1c",
            "description": "earth-monitor order",
            "service": "earth-monitor",
            "amountUnit": "credits"
        },

Get Payment for a Contract and Payment ID


API Endpoint	/api/v1/contracts/{contractId}/payments/{paymentId}
REST verb	GET
Authentication	Bearer Token
API Reference	API orders and manage contract.
API Get request	(Use the access token retrieved during authentication step).

Parameters	Required	Description
contractId	yes	String ; contract id
paymentId	yes	String ; payment id

Here is an example to get payment information for a contract:

curl -X GET \
  'https://data.api.oneatlas.airbus.com/api/v1/contracts/{contractId}/payments/{paymentId}' \
  -H 'Authorization: Bearer ' \
  -H 'Content-Type: application/json' \

     
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://data.api.oneatlas.airbus.com/api/v1/contracts/{contractId}/payments/{paymentId}");
xhr.setRequestHeader("Authorization", "Bearer <access_token>");
xhr.setRequestHeader("Content-Type", "application/json");

xhr.send(data);

     
import requests

url = "https://data.api.oneatlas.airbus.com/api/v1/contracts/{contractId}/payments/{paymentId}"

headers = {
    'Authorization': "Bearer <access_token>",
    'Content-Type': "application/json",
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

This will return:

{
    "_links": {
        "self": {
            "href": "https://data.api.oneatlas.airbus.com/api/v1/payments/5c247131-1b8e-4cba-a373-8e54089c6210"
        },
        "contract": {
            "href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/ff731b8d-5637-40aa-89ad-daa736613714"
        },
        "order": {
            "href": "https://data.api.oneatlas.airbus.com/api/v1/orders/7ea032fe-428a-4ba1-92d9-533898c516a0"
        },
        "subscription": {
            "href": "https://data.api.oneatlas.airbus.com/api/v1/subscriptions/8fe89b39-9745-40b1-9a1f-5ce98aba2b13"
        },
        "parentPayment": {
            "href": "https://data.api.oneatlas.airbus.com/api/v1/payments/88dc3fb6-0fe3-4959-b26b-481fbd3475c5"
        }
    },
    "id": "5c247131-1b8e-4cba-a373-8e54089c6210",
    "amount": 1056,
    "type": "consumption",
    "createdAt": "2019-08-01T05:45:21.330984+00:00",
    "createdBy": "service_account",
    "description": "Consumption Update : Adjustment of the real weight of the product order.",
    "service": "data",
    "amountUnit": "kB"
}

Get Payment for an Order


API Endpoint	/api/v1/orders/{orderId}
REST verb	GET
Authentication	Bearer Token
API Reference	API orders and manage contract.
API Get request	(Use the access token retrieved during authentication step).

Parameters	Required	Description
orderId	yes	String ; order id

Here is an example to get payment and deliveries information for an order:

curl -X GET \
  'https://data.api.oneatlas.airbus.com/api/v1/orders/{orderId}' \
  -H 'Authorization: Bearer ' \
  -H 'Content-Type: application/json' \

     
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://data.api.oneatlas.airbus.com/api/v1/orders/{orderId}");
xhr.setRequestHeader("Authorization", "Bearer <access_token>");
xhr.setRequestHeader("Content-Type", "application/json");

xhr.send(data);

     
import requests

url = "https://data.api.oneatlas.airbus.com/api/v1/orders/{orderId}"

headers = {
    'Authorization': "Bearer <access_token>",
    'Content-Type': "application/json",
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

This will return:

{
    "_links": {
        "self": {
            "href": "https://data.api.oneatlas.airbus.com/api/v1/orders/e7e68aab-d908-4371-a52b-bfb07b15b1c2"
        },
        "cancel": {
            "href": "https://data.api.oneatlas.airbus.com/api/v1/orders/e7e68aab-d908-4371-a52b-bfb07b15b1c2/cancel"
        },
        "contract": {
            "href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/ff731b8d-5637-40aa-89ad-daa736613714"
        },
        "payments": {
            "href": "https://data.api.oneatlas.airbus.com/api/v1/orders/e7e68aab-d908-4371-a52b-bfb07b15b1c2/payments"
        },
        "deliveries": {
            "href": "https://data.api.oneatlas.airbus.com/api/v1/orders/e7e68aab-d908-4371-a52b-bfb07b15b1c2/deliveries"
        },
        "subscription": {
            "href": "https://data.api.oneatlas.airbus.com/api/v1/subscriptions/8fe89b39-9745-40b1-9a1f-5ce98aba2b13"
        }
    },
    "id": "e7e68aab-d908-4371-a52b-bfb07b15b1c2",
    "kind": "order.data.gb.product",
    "service": "data",
    "createdAt": "2019-08-08T14:24:39.179877+00:00",
    "createdBy": "9915b46a-cddd-48e0-49e0-1cc1ddaea356",
    "status": "delivered",
    "contractId": "ff731b8d-5637-40aa-89ad-daa736613714",
    "isAmountEstimated": "false",
    "price": 1001,
    "amount": 1001,
    "amountUnit": "kB",
    "estimatedAmount": 1000,
    "payload": {
        "kind": "order.data.gb.product",
        "products": [
            {
                "id": "1fa9b7fd-c9cc-4613-a8c3-809a860e1b7c",
                "crsCode": "urn:ogc:def:crs:EPSG::4326",
                "productType": "bundle",
                "radiometricProcessing": "REFLECTANCE",
                "aoi": {
                    "type": "Polygon",
                    "coordinates": [
                        [
                            [
                                -1.8026661007249345,
                                50.7207034088934
                            ],
                            [
                                -1.8026661007249345,
                                50.7203160156314
                            ],
                            [
                                -1.802106060902048,
                                50.7203160156314
                            ],
                            [
                                -1.802106060902048,
                                50.7207034088934
                            ],
                            [
                                -1.8026661007249345,
                                50.7207034088934
                            ]
                        ]
                    ]
                },
                "imageFormat": "image/jp2"
            }
        ]
    },
    "deliveries": [
        {
            "_links": {
                "self": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/deliveries/514d7866-242d-456c-b8f2-a07dd885e69b"
                },
                "contract": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/ff731b8d-5637-40aa-89ad-daa736613714"
                },
                "catalogUrl": {
                    "href": "https://search.foundation.api.oneatlas.airbus.com/api/v1/opensearch?id=f731ea30-a70d-4b2c-bfc3-a423f6e00e50"
                },
                "catalogItem": {
                    "href": "https://search.foundation.api.oneatlas.airbus.com/api/v1/opensearch?id=f731ea30-a70d-4b2c-bfc3-a423f6e00e50"
                },
                "download": {
                    "href": "https://access.foundation.api.oneatlas.airbus.com/api/v1/items/f731ea30-a70d-4b2c-bfc3-a423f6e00e50/download"
                },
                "payment": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/ff731b8d-5637-40aa-89ad-daa736613714/payments/1691a8fd-a66d-48d7-8b0e-895fe4c23f1c"
                }
            },
            "id": "514d7866-242d-456c-b8f2-a07dd885e69b",
            "kind": "delivery.data.product",
            "service": "data",
            "createdAt": "2019-08-08T14:24:39.227977+00:00",
            "status": "delivered",
            "isAmountEstimated": "false",
            "price": 1001,
            "amount": 1001,
            "estimatedAmount": 1000,
            "amountUnit": "kB",
            "datas": {
                "id": "1fa9b7fd-c9cc-4613-a8c3-809a860e1b7c",
                "crsCode": "urn:ogc:def:crs:EPSG::4326",
                "productType": "bundle",
                "radiometricProcessing": "REFLECTANCE",
                "aoi": {
                    "type": "Polygon",
                    "coordinates": [
                        [
                            [
                                -1.8026661007249345,
                                50.7207034088934
                            ],
                            [
                                -1.802106060902048,
                                50.7207034088934
                            ],
                            [
                                -1.802106060902048,
                                50.7203160156314
                            ],
                            [
                                -1.8026661007249345,
                                50.7203160156314
                            ],
                            [
                                -1.8026661007249345,
                                50.7207034088934
                            ]
                        ]
                    ]
                },
                "imageFormat": "image/jp2",
                "sourceId": "DS_PHR1A_201908051125061_FR1_PX_W002N50_0219_01556",
                "sensor": "PHR",
                "segmentFootprint": {
                    "coordinates": [
                        [
                            [
                                -2.037869767221136,
                                50.82837536212787
                            ],
                            [
                                -1.740358259385513,
                                50.83264585362854
                            ],
                            [
                                -1.740374842671926,
                                50.673384500826
                            ],
                            [
                                -2.037734178571856,
                                50.6700684035067
                            ],
                            [
                                -2.037869767221136,
                                50.82837536212787
                            ]
                        ]
                    ],
                    "type": "Polygon"
                },
                "areaKm2": 0
            },
            "updatedAt": "2019-08-08T14:26:53.439520+00:00",
            "deliveredAt": "2019-08-08T14:26:53.439520+00:00"
        }
    ]
}

Language

Manage Contract

Retrieve your Account Information

Get User Roles

Get Contract Information

Get All Subscriptions for a Given Contract

Get Information for a Specific Subscription

Revoke a Subscription

Refunding Your Account

Get Payments for a Contract

Get Payments for a Subscription

Get Payment for a Contract and Payment ID

Get Payment for an Order